To be Master

[influxdb] token 확인하기

tbMaster — Tue, 6 Dec 2022 18:58:14 +0900

개발환경에 문제가 생겨 influxdb를 다시 설치하였다.

그리고 언제나처럼 influxdb ui에 들어가서 api token 을 확인하려고 하니...

왠걸...안보인다... ㅎ

admin token이 생성되어 있지만, token 확인 불가능

그래서 열심히 찾아봤고, 그 내용을 정리한다.

사전 준비 사항

- influxd 설치

- influx 설치

token 확인 방법

1. influx에 config 설정

influx 가 설치된 경로로 진입하여, config 파일을 생성한다. config 명은 default로 할 경우, influx 실행 시, 따로 config 명을 입력하지 않아도 되며, host-url, org, token 은 각자 본인에 맞게 작성하도록 한다.

※ token 확인하려는데, token을 입력해야 한다. 이 경우, influxdb ui 에서 token 하나 생성해서, 생성한 token을 입력하면 된다.

[ influx config 생성 명령어 (influxdb 문서 캡처 화면) ]

2. influx 로 token 확인

influx 가 설치된 경로로 진입하여, ./influx auth list 명령을 실행하면, 등록된 모든 Token 정보들이 출력된다.

$./influx auth list

[ influx auth list 명령을 실행해서 나온 결과 화면 ]

Reference

https://docs.influxdata.com/influxdb/v2.5/tools/influx-cli/?t=Linux

Install and use the influx CLI | InfluxDB OSS 2.5 Documentation

Thank you for your feedback! Let us know what we can do better:

docs.influxdata.com

https://docs.influxdata.com/influxdb/v2.5/reference/cli/influx/auth/list/

influx auth list | InfluxDB OSS 2.5 Documentation

Thank you for your feedback! Let us know what we can do better:

docs.influxdata.com

[mysql] ubuntu 18.06에서 MySQL 설치 및 외부접속 허용하기

tbMaster — Tue, 11 Oct 2022 14:40:19 +0900

MySQL에 설치할 때마다 여기저기 찾아보기 힘들어, 이참에 블로그에 정리해보고자 한다.

1. MySQL 설치하기

2. 외부접속 IP 허용 설정하기

3. 외부접속 사용자 설정하기

4. 테스트

MySQL 설치하기

아래 명령을 통해, Ubuntu에서 mysql server 를 설치한다.

$ sudo apt install mysql-server

아래 명령을 통해, 정상 설치되었는지 확인한다. 하단 캡처이미지와 같이 "active"가 뜨면 정상 설치된 것이다.

$ sudo service mysql status

[ service 명령어를 이용해, mysqld 동작 확인 ]

외부접속 IP 허용 설정하기

MySQL의 설정파일을 수정하여, 외부 접속이 가능하도록 변경한다.

아래 경로의 mysqld.cnf 파일을 수정한다.

$ sudo vi /etc/mysql/mysql.conf.d/mysqld.cnf

수정 내용은 bind-address 이며, bind-address = 127.0.0.1 -> 0.0.0.0 으로 변경하고, 저장한다.

[ mysqld.cnf 파일 내용 ]

mysqld.cnf 의 파일 변경이 끝났으면, mysql 을 재시작한다.

$ sudo service mysql restart

외부접속 사용자 설정하기

아래 명령을 통해, mysql에 접속한다. mysql 명령을 찾을 수 없다고 하면, "/usr/bin/mysql -u root -p" 로 접속한다.

$ mysql -u root -p

사용자를 생성하고, 원격 접속을 허용한다.

- 아래 명령을 이용하면, 현재 저장된 User 정보를 확인할 수 있다.

mysql> select User, Host, authentication_string from mysql.user;

[ select 문을 이용해 User 정보 확인 결과 ]

- 생성하고자 하는 사용자에 localhost 및 외부 접속이 가능하도록 설정한다. (여기서는 "user"를 생성하고자 한다.)

# localhost 설정 및 모든 권한 부여
mysql> create user 'user'@localhost indentified by 'password';
mysql> grant all privileges on *.* 'user'@localhost;

# 모든 IP 허용 설정 및 모든 권한 부여
mysql> create user 'user'@'%' indentified by 'password';
mysql> grant all privileges on *.* 'user'@'%';


# 사용자 생성 및 권한 부여 내용 적용
mysql> flush privileges;

[ localhost, 모든 IP 허용하는 user 생성 결과 화면 ]

※ 특정 IP 대역에 대해서만 원격 접속을 허용하고 싶다면, % 대신 xxx.xxx.% 와 같이 설정하면 된다.

ex) 192.168.0.xxx 하위에 있는 모든 IP 설정 시 -> 192.168.0.%

192.168.xxx.xxx 하위에 있는 모든 IP 설정 시 -> 192.168.%

테스트

아래는 workbench를 이용해서, connection 테스트를 한 결과이다. Successfully 메시지가 뜨며, 잘 연결됨을 확인할 수 있다.

참고

https://ubuntu.com/server/docs/databases-mysql

Databases - Mysql | Ubuntu

Ubuntu is an open source software operating system that runs from the desktop, to the cloud, to all your internet connected things.

ubuntu.com

https://www.hostinger.com/tutorials/mysql/how-create-mysql-user-and-grant-permissions-command-line

How to Create MySQL User and Grant Privileges: A Beginner's Guide

In this article, you'll learn the basics of MySQL databases. We'll show you how to create a MySQL user and grant or revoke its privileges.

www.hostinger.com

[spring-rest-docs] adoc 파일을 pdf로 저장하는 방법

tbMaster — Wed, 5 Oct 2022 14:46:30 +0900

spring-rest-docs를 적용해서 html로 API 문서를 공유하면 편하다. 하지만, 제출용으로 html 링크를 보낼 수 없는 관계로 pdf 형식으로 변경해야 했다.

아래는 spring-rest-docs 를 적용하여, .adoc 파일이 다 만들어졌다는 가정하에, pdf 로 문서를 만드는 방법에 대해서 소개한다.

spring-rest-docs 적용 링크는 아래를 참고해주세요~

[링크]

https://tbmaster.tistory.com/96

adoc 파일 -> pdf 변환 방법

$asciidoctor-pdf ./index.adoc -o ./publisher.pdf

명령어 asciidoctor-pdf 를 입력하고 변환하고자 하는 파일(index.adoc), 결과파일(publisher.pdf) 를 입력한다.

그러면, 결과는 현재위치(./) 에 publisher.pdf 파일이 생성됨을 확인할 수 있다.

asciidoctor-pdf 설치 방법

asciidoctor-pdf 는 Ruby로 되어 있어, ruby 를 설치해야 한다.

1. 아래 Ruby 사이트에서 RubyInstaller를 다운로드하여, 설치한다.

https://rubyinstaller.org/downloads/

Downloads

Which version to download? If you don’t know what version to install and you’re getting started with Ruby, we recommend that you use the Ruby+Devkit 3.1.X (x64) installer. It provides the biggest number of compatible gems and installs the MSYS2 Devkit

rubyinstaller.org

2. Ruby의 gem을 이용하여, asciidoctor-pdf 를 설치한다.

gem 명령은 설치한 Ruby 에서 bin 폴더로 이동하면, gem 파일이 있다. 해당 위치까지 이동하여 아래 명령어를 실행한다.

$gem install asciidoctor-pdf

[ asciidoctor-pdf 설치 예시 ]

설치가 완료되면, 아래와 같이 "asciidoctor-pdf -v" 을 이용해 버전 정보를 확인할 수 있다.

[ asciidoctor-pdf  버전 정보 확인 ]

설치가 완료되면, 위의 "adoc파일 -> pdf 변환방법" 을 진행하면 된다.

한글이 깨질 경우

adoc을 pdf로 변환 후, 한글이 네모박스로 표시되어 변환되었다. 아래와 같이 수정하여, 한글도 출력되도록 하자.

1. 한글 폰트를 찾아, Ruby의 data/fonts 폴더에 넣는다. (나의 경우, Windows 에 있는 한글폰트 중 하나를 사용했다.)

[ Ruby의 한글 폰트 저장 경로 ]

2. Ruby의 themes 폴더에서 default-teme.yml에 추가한 한글 폰트로 시작하도록 값을 변경한다.

[ default-theme.yml 파일이 존재하는 경로 ]

default-theme.yml 파일을 열면 아래와 같은 내용이 나타나며, 한글 폰트를 아래와 같이 입력한다.

Noto Serif 와 M+ 1mn 부분을 같이 변경해줘야, adoc의 box 내부 한글도 잘 변환된다.

[ default 폰트 변경 ]

3. 이후에 다시, "adoc 파일 -> pdf 변환방법"을 재실행한다.

참고

https://docs.asciidoctor.org/pdf-converter/latest/install/

Asciidoctor PDF - Install Asciidoctor PDF

A documentation page for Asciidoctor PDF.

docs.asciidoctor.org

https://docs.asciidoctor.org/pdf-converter/latest/convert-to-pdf/

Asciidoctor PDF - Convert AsciiDoc to PDF

A documentation page for Asciidoctor PDF.

docs.asciidoctor.org

https://wiznxt.tistory.com/857

Asciidoc adoc 파일 pdf 변환시 한글 폰트 해결 팁 (잔머리)

Asciidoc을 이용해서 html pdf 내보내기 되고, 마크다운 같이 관리되고 다 좋은데 이것 참 pdf export 하면 기본적으로 한글이 네모난 칸으로 나오는 문제가 발생. 많은 해결했다는 곳들이 있지만, 나만

wiznxt.tistory.com

[mongodb] image, video 저장하기

tbMaster — Tue, 27 Sep 2022 18:53:45 +0900

개발을 시작하면서, 이미지, 영상을 저장해야 할 일이 생겼다. 그래서 어떠한 방법들이 있는지 조사하던 중에 MongoDB에서 image, video를 저장할 수 있다하여, 테스트를 진행해보았다.

결과

이미지 저장 및 가져오기

: ./image/image1.png 파일을 mongoDB에 저장하는 테스트 코드이다.

: mongoDB에 저장된 이미지를 불러와 ./result/mongo/image1.png 로 저장하는 테스트 코드이다.

MongoDB에서 이미지와 영상은 동일한 코드로 저장되고, 불러올 수 있다. 아래는 영상에 대한 저장 및 불러오기 테스트 코드이며, 이미지와 다르지 않다는 것을 확인할 수 있다.

영상 저장 및 불러오기

테스트 수행 후, 생성된 결과 이미지, 영상이다.

동작 코드

spring-boot 에서 제공하는 mongodb를 dependecy 하였다.

implementation 'org.springframework.boot:spring-boot-starter-data-mongodb:2.7.4'

GridFSTemplate을 이용하여, GridFS을 이용할 수 있는데, 아래는 GridFSTemplate 이용을 위한 설정 코드이다.

// [1]
MongoCredential mongoCredential =
        MongoCredential.createCredential([userName],[database],[password]);

// [2]
mongoClient = MongoClients.create(MongoClientSettings.builder()
        .credential(mongoCredential)
            .applyConnectionString(new ConnectionString("mongodb://[mongdb_host]:[mongodb_port]")).build());

// [3]
mongoDatabaseFactory = new SimpleMongoClientDatabaseFactory(mongoClient, db);

// [4]
mappingMongoConverter = new MappingMongoConverter(new DefaultDbRefResolver(mongoDatabaseFactory),
        new MongoMappingContext());

// [5]
gridFsTemplate = new GridFsTemplate(mongoDatabaseFactory, mappingMongoConverter);

[1] MongoCredential : MongoDB에 생성한 데이터베이스에 접근하기 위한 인증을 설정하는 클래스로, userName, database, password를 작성해야 한다. 나의 경우, mongodb 에 데이터베이스를 생성한 후, authetication을 부여했기 때문에 MongodCredential을 사용하여 접근 가능하도록 하였다.

[2] MongoClient : MongoDB에 접근하기 위한 Client를 생성하는 클래스로, MongoClientSettings를 이용해 MongoClient에 필요한 각종 설정을 작성하였다.

※ 참고: MongoCredential 등 부가적인 설정을 할 필요가 없다면, [3]의 MongoDatabaseFactory에서 내부적으로 MongoClient를 생성해주기 때문에 따로 정의할 필요없다.

[3],[4] MongoDatabaseFactory, MappingMongoConverter : GridFsTemplate 에 파라미터로 필요하여 생성하였다.

※ MappingMongoConverter는 아직 잘 모르겠다....ㅜ

[5] GridFsTemplate : 이미지, 영상등의 binary 데이터를 조작하기 위해, spring boot에서 제공하는 Template 이다.

저장 코드

저장하는 데이터에 대한 메타 정보를 저장할 수 있으며, MetaData를 통해 가능하다.

public void saveObject(@NotNull byte[] bytes, @NotNull String filename, String contentType) {
    DBObject metaData = new BasicDBObject();
    //metaData.put("name", name);
    gridFsTemplate.store(new ByteArrayInputStream(bytes), filename, contentType, metaData);
}

조회 코드

저장된 바이너리 데이터를 가져오고 싶을 경우, getResource 메서드를 이용해서 가져온다.

   public Object findObject(String filename) {
        InputStream inputStream = gridFsTemplate.getResource(filename).getContent();
        return inputStream;
    }

GridFS

GridFS는 바이너리로 데이터를 조작할 수 있게 한다. 단, 일정크기 이상으로 데이터가 크면, chunk 단위로 잘라 여러 여러 document에 저장한다. chunk 당 document 하나이다. chunk는 기본적으로 255kB로 설정되어 있다.

GridFS 를 쓰게 되면 2개의 Collection이 생성되어 데이터가 저장되는데, "fs.chunks", "fs.files" collection이 만들어진다.

fs.chunks 는 실제 binary 데이터가 저장되는 collection 이며, fs.files 는 binary 데이터에 대한 metadata가 저장되는 collection이다.

fs.files 에 저장된 데이터

fs.chunks 에 저장된 데이터

참고자료

https://www.baeldung.com/spring-data-mongodb-gridfs

GridFS in Spring Data MongoDB | Baeldung

A quick guide to interacting with GridFS using Spring Data MongoDB.

www.baeldung.com

https://docs.spring.io/spring-data/mongodb/docs/current/api/org/springframework/data/mongodb/gridfs/GridFsTemplate.html

GridFsTemplate (Spring Data MongoDB 3.4.3 API)

org.bson.types.ObjectId store(InputStream content, String filename, String contentType, Object metadata) Stores the given content into a file with the given name and content type using the given metadata.

docs.spring.io

https://www.mongodb.com/docs/manual/core/gridfs/

GridFS — MongoDB Manual

Docs Home → MongoDB Manual GridFS is a specification for storing and retrieving files that exceed the BSON-document size limit of 16 MB.Instead of storing a file in a single document, GridFS divides the file into parts, or chunks , and stores each chunk

www.mongodb.com

https://docs.spring.io/spring-data/mongodb/docs/current/reference/html/#mongo.mongo-db-factory

Spring Data MongoDB - Reference Documentation

abs, acos, acosh, add (* via plus), asin, asin, atan, atan2, atanh, ceil, cos, cosh, derivative, divide, exp, floor, integral, ln, log, log10, mod, multiply, pow, round, sqrt, subtract (* via minus), sin, sinh, tan, tanh, trunc

docs.spring.io

[influxdb] influxdb-client-java 라이브러리 연동(+ 문제 해결)

tbMaster — Wed, 14 Sep 2022 17:44:48 +0900

spring boot 프로젝트에 influxdb 를 연동해야 했다.

spring boot 프로젝트는 java 언어로 작성되어 있었으며, build 툴은 gradle 이었다.

이미 spring boot 프로젝트에 influxdb-client-java, flux-dsl 라이브러리가 설치되어 있었고, 큰 문제 없이 사용하고 있었다.

그런데 기능을 추가하면서 필요한 기능이 생겼고, 해당 기능을 사용하려니, flux-dsl 의 버전이 낮아 기능을 제공하지 않았다.

그래서 기존 4.xx -> 6.5.0 으로 변경했다.

    implementation 'com.influxdb:influxdb-client-java:6.5.0'
// https://mvnrepository.com/artifact/com.influxdb/flux-dsl
   implementation "com.influxdb:flux-dsl:6.5.0"

문제 발생

여기서 아래와 같은 에러가 발생하였다.

java.lang.NoClassDefFoundError: kotlin/jvm/internal/Intrinsics

문제 원인

해당 에러는 influxdb-client-java 라이브러리에서 제공하는 InfluxDBClientFactory.create 를 이용해,InfluxDBClient 를 생성할 때 발생하였다.

{
    ...
    InfluxDBClient client = InfluxDBClientFactory.create(url, token, org, bucket);
    ...
}

정확한 문제를 찾기 위해, InfluxDBClientFactory.create 메서드를 타고 들어갔고, 원인을 알 수 있었다.

InfluxDBClientFactory를 이용해 InfluxDBClient 생성할 경우,InfluxDBClientOptions를 생성하게 되는데, InfluxDBClientOptions에서 okhttp3 라이브러리를 이용하게 된다.

이 라이브러리에서 사용하는 클래스들 중에는 Kotlin으로 작성된 클래스도 있는데, Influxdb 라이브러리가 결과적으로 kotlin 클래스를 사용하게 되는 것이다.

그런데, 현재 프로젝트가 kotlin 클래스를 빌드할 수 없기 때문에 위와 같은 에러가 발생한 것이다.

(모든 건 로그에 잘 나와있었지만, 인지하지 못했다...)

해결방법

kotlin 클래스도 빌드할 수 있게 만들어 주면 된다.

아래와 같이, "kotlin-stdlib" 를 dependency에 추가해주면 정상적으로 동작된다.

※ 에러 발생 후, 에러 원인과 해결방법까지 찾는데 많은 시간이 소요됐지만, 의외로 해결방법은 간단했다...ㅎ

로그를 꼼꼼히 본다고 했는데, 왜 인지하지 못했는지.... 이 기회를 발판 삼아 로그를 더 잘 봐야겠다는 생각이 든다.

influxdb 라이브러리 관련 docs

https://github.com/influxdata/influxdb-client-java/tree/master/client

GitHub - influxdata/influxdb-client-java: InfluxDB 2 JVM Based Clients

InfluxDB 2 JVM Based Clients. Contribute to influxdata/influxdb-client-java development by creating an account on GitHub.

github.com

https://github.com/influxdata/influxdb-client-java/tree/master/flux-dsl

GitHub - influxdata/influxdb-client-java: InfluxDB 2 JVM Based Clients

InfluxDB 2 JVM Based Clients. Contribute to influxdata/influxdb-client-java development by creating an account on GitHub.

github.com

[ Annotation ] Custom Annotation 만들기

tbMaster — Thu, 28 Jul 2022 17:44:50 +0900

커스텀 애너테이션을 만들게 된 이유

개발을 하다가 RestController 에서 하나의 메서드에 서로 다른 RequestBody를 받고 싶었다.

상황)

어떠한 서비스에 대한 동작을 제어하는 메서드 였으며, 동작제어 (시작, 종료) 에 따라, RequestBody에 포함하는 속성이 조금 달랐다.

1안)

동작제어 별로 메서드 따로 둠.

=> 고민을 하긴 했는데, 동일한 대상에 속성 값만 달라지는데, 메서드를 따로 둘만큼 기능 상에 큰 차이가 있다고 생각하지 않았기 때문에 일단 패스하였다.

2안)

메서드 파라미터에 @RequestBody 로 바로 타입 변환하지 않고, HttpRequestServlet을 이용하여, 동작제어에 맞는 타입으로 직접 변환

=> 원래 하고자 했던 기능을 구현할 수 있다. 하나의 메서드에 서로 다른 동작에 따라 다른 RequestBody를 받을 수 있다. 그래서 이 방법을 채택하여 진행하였다.

하단은 그 결과에 따른 코드이다.

    @PatchMapping("[경로]")
    public Response<Void> exec( ....,
                                            HttpServletRequest request){
        
        //HttpServletRequest 에서 body 추출
        StringBuilder sb = new StringBuilder();
        try(BufferedReader br = new BufferedReader(new InputStreamReader(request.getInputStream()))){
            String tmp = "";
            while( (tmp = br.readLine())!= null){
                sb.append(tmp);
            }
        }catch(IOException e){
            throw new InvalidRequestException(ErrorCode.INVALID_REQUEST, ErrorCode.INVALID_REQUEST.getMessage());
        }
        
        //추출한 body를 JsonObject로 변환
        Gson gson = new Gson();
        JsonObject jsonObject = gson.fromJson(sb.toString(), JsonObject.class);
        
        //동작제어에 따른 서로 다른 객체로 타입 변환
        String requestStatus = jsonObject.get("status").getAsString();
        if("START".equals(requestStatus)){
            StartRequest startRequest = new StartRequest(Status.START, jsonObject.get("id").getAsLong());
            ...
        }else if("STOP".equals(requestStatus)){
            StopRequest stopRequest = new StopRequest(Status.STOP);
            ...
        }else{
            throw new InvalidRequestException(ErrorCode.INVALID_REQUEST, ErrorCode.INVALID_REQUEST.getMessage());
        }

		...
       
    }

위 코드는 동작에 따라 각 기능을 수행하기까지, 앞서서 처리해야할 일이 많다.

1. HttpServletRequest 에서 body를 추출

2. 동작을 판별에 따른 객체 타입을 다르게 하기 위한, 동작 확인을 위해 JsonObject로 변환

3. 원래 하고자 했던 동작에 따른 기능 수행

그래서 이를 @RequestBody가 타입 변환해주는 것처럼, 동작에 맞는 타입변환 애너테이션을 만들면 간단하게 원래 기능을 수행할 수 있을 것이라고 생각했다.

커스텀 애너테이션을 이용하여, @RequestBody 처럼 request의 body를 객체로 변환하기

1. @interface 선언

2. 구현체 만들기

3. 등록하기

4. 사용하기

1. @Interface 선언

하단은 ExecRequestBody 명의 애너테이션을 선언한 코드이다.

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface ExecRequestBody {
}

2. 구현체 만들기

※ 하단의 코드에서 StartRequest와 StopRequest를 ExecRequest를 상속받는다.

@Component
public class ExecRequestBodyArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.getParameterAnnotation(ExecRequestBody.class) != null;
    }

    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        
        //HttpServletRequest에서 body 추출 
        HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
        StringBuffer sb = new StringBuffer();
        try(BufferedReader br = new BufferedReader(new InputStreamReader(request.getInputStream()))){
            String tmp = "";
            while( (tmp = br.readLine()) != null){
                sb.append(tmp);
            }
        }catch(IOException e){
            return null;
        }
        return convertToObject(sb.toString());
    }

	//Request Body를 동작에 따른 객체로 변환
    private ExecRequest convertToObject(String str){
        Gson gson = new Gson();
        JsonObject jsonObject = gson.fromJson(str, JsonObject.class);
        if(jsonObject.get("status") != null
                && jsonObject.get("status").getAsString().equals("START")
                && jsonObject.get("id") != null){
                
           ....
          
            return new StartRequest(Status.START, id);
        }else if(jsonObject.get("status") != null
        && jsonObject.get("status").getAsString().equals("STOP")){
        
        ...
        
            return new StopTrainingRequest(Status.ModelTraining.TERMINATED);
        }
        throw new InvalidRequestException(ErrorCode.INVALID_REQUEST, ErrorCode.INVALID_REQUEST.getMessage());
    }

3. 등록하기

@RequiredArgsConstructor
@Configuration
public class WebConfig implements WebMvcConfigurer {

    private final ExecRequestBodyArgumentResolver execRequestBodyArgumentResolver;
    
    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
        resolvers.add(execRequestBodyArgumentResolver);
        WebMvcConfigurer.super.addArgumentResolvers(resolvers);
    }
}

4. 사용하기

메서드 파라미터로 앞서 구현한 커스텀 애너테이션인 @ExecRequestBody를 붙여주어 사용하면 된다.

   @PatchMapping("[경로]")
    public Response<Void> exec( ...,
                               @ExecRequestBody ExecRequest request) {

        if (request instanceof StartRequest) {
        
            //Start일 때의 로직
            
        } else if (request instanceof StopRequest) {
            
            //Stop일 때의 로직
            
        }
        ...
    }

Reference

https://growing-up-constantly.tistory.com/53

[Spring] RequestParam값 객체로 매핑하기, Custom Annotation 만들기

스프링 Controller에서 Request값을 도메인객체를 사용해서 받을 때는 Json으로 넘어오는 경우에는 requestBody로 받으면 손쉽게 해결할 수 있었다. 위의 상황을 코드로 이야기하자면 다음과 같다. @Reques

growing-up-constantly.tistory.com

https://shinsunyoung.tistory.com/83

Spring Boot Custom Annotation 만들기

안녕하세요! 이번 포스팅에서는 Spring Boot에서 Custom Annotation을 만드는 방법에 대해 알아보겠습니다. 전체 코드는 Github에서 확인이 가능합니다. ✍️ 개념 정리 1. 커스텀 어노테이션이란? 프

shinsunyoung.tistory.com

본 글에서 확인한 것처럼 커스텀 애너테이션을 사용했을 때 더욱 명확하게 기능을 파악할 수 있었다.

※ 커스텀 애너테이션 사용은 코드 분석에 어려움을 주기 때문에, 반드시 필요한 경우가 아니라면, 남용해서는 안된다.

[ spring-rest-docs ] prettyPrint()를 setUp 메서드에 적용하기

tbMaster — Tue, 12 Jul 2022 10:03:41 +0900

나는 Rest API를 Spring Rest Docs을 이용하여, 문서를 생성한다. 그리고 request 및 response 가 보기 쉽게 정렬되서 나오는 prettyPrint를 각 메서드에 적용하여 사용하였다.

그러다 최근에 각 메서드 마다 적용하는 prettyPrint를 setUp에 사용 방법 그대로 적용하였더니, 동작되지 않았고, 디버깅한 결과 mockMvc에 configuration에 적용되지 않음을 알게되었다. 그래서 하는 방식을 정리해 둔다.

동작되는 코드(Test 메서드)

[ 테스트 메서드마다 andDo에 작성했던 방식 ]

동작 안되는 코드(setUp 메서드)

[ setUp 메서드에 prettyPrint 적용한 코드 ]

동작되는 코드(setUp 메서드)

[ setUp 메서드에 prettyPrint 적용한 콛, ]

withRequestDefaults, withResponsedefaults

request preprocessor, response preprocessor의 기본 설정값을 제공하는 메서드다.

[ OperationPreprocessorsConfigurer.java ]

[JAVA] JAVA 로 SCP 실행하는 방법 (jSch 라이브러리)

tbMaster — Tue, 5 Jul 2022 21:13:26 +0900

JAVA로 command 명령어를 작성할 수 있다. ProcessBuilder 를 이용하면 되는데, 나는 처음에 ProcessBuilder를 이용하여 scp를 실행하려고 하였다.

그런데, ProcessBuilder 를 이용해 scp를 사용하려면, password 입력을 처리가 어려워지는 문제가 있었다.

그래서 다른 방법을 찾아보던 중, jSch 라이브러리를 이용하여, scp를 실행시킬 수 있음을 알았다.

외부 라이브러리 추가

<!-- scp -->
<dependency>
    <groupId>com.jcraft</groupId>
    <artifactId>jsch</artifactId>
    <version>0.1.55</version>
</dependency>

scp 파일 전송 코드

       JSch jSch = new JSch();
        Session session;

        try {
            session = jSch.getSession(accountUserName, scpAddr);
            session.setPassword(accountPassword);
            session.setPort(scpPort);

            Properties config = new Properties();
            config.put("StrictHostKeyChecking", "no");
            session.setConfig(config);

            session.connect();
            Channel channel = session.openChannel("sftp");
            ChannelSftp channelSftp = (ChannelSftp) channel;
            channelSftp.connect();

            channelSftp.put(srcPath + "/" + filename, dstPath + "/" + filename);

            channelSftp.quit();
            channel.disconnect();
            session.disconnect();

        } catch (JSchException | SftpException e) {
            e.printStackTrace();
        }

코드를 좀 보자면,

1. 일단 전송하려는 서버의 Host Name 과 Host IP를 입력해야 한다.

ex) 내 host pc 명이 KIM 이고 IP가 127.0.0.1 이라면, jSch.getSession("KIM", "127.0.0.1");

2. 그리고 전송하는 서버가 password가 걸려있다면, session.setPassword를 이용하여, 비밀번호를 입력하면 된다.

※ 이것때문에, jSch 라이브러리를 사용하게 된 것이다.

3. 그리고 Host 서버에서 ssh 로 default로 22 번이 아닌 다른 포트를 이용하고 있다면, session.setPort를 이용하여, ssh 포트를 입력하면된다.

그 이후로는 위 코드대로 sftp 채널을 열어서 파일을 보내주고 닫으면 된다.

jSch 라이브러리 쓰면서 주의해야 할 점

jSch 라이브러리가 password 에 대한 고민을 해결해주는 좋은 친구였지만, 나를 애먹게 하기도 했다.

Host에 파일을 전송할 경로를 지정하는 부분이었는데, 나는 scp 를 이용하면, 전체 경로를 작성한다. 예를 들어 C:/Users/KIM/Desktop/data 이런 식으로 작성을 하는데, 이 부분에서 문제가 있었다.

jSch 는 C:/Users/KIM 까지 알아서, Host의 default 경로를 가져와서, 내가 입력한 Host의 경로에 붙이는 것이다.

즉, 내가 C:/Users/KIM/Desktop/data 입력했다면, jSch는 자동으로 C:/Users/KIM/C:/Users/KIM/Desktop/data 이렇게 만들어준다는 뜻이다.

따라서, Host에 파일을 전송할 경로에는 C:/Users/KIM 을 제외한 나머지 경로를 넣어줘야 제대로 된 경로가 만들어지며, 파일을 원하는 위치에 잘 전송할 수 있다.

또한, 참고로 더 얘기하면, 전체 경로가 존재해야만 파일을 전송할 수 있다.

....

22.7.7 절대경로에 대한 내용을 추가하자면, jSch 의 경우 경로의 첫 문자가 '/'로 시작하면, 절대경로라고 본다. 그러나, 이 부분이 리눅스에서는 /home/~... 된다지만, 윈도우에서는 C:/로 시작한다... 윈도우에서는 jSch에서 얘기하는 절대경로 규칙을 따를수가 없다...( 있다면 댓글에 남겨주시면 ...) 암튼 그래서 엄청 해맸다. 나처럼 jSch를 사용하는데 윈도우를 쓰는 사람이라면, 이 내용이 도움이 되길!

[ Docker ] Docker 외부 포트 설정 (직접 명령어 & REST API 적용)

tbMaster — Tue, 5 Jul 2022 20:54:31 +0900

오늘 참 험난한 하루였다... 내가 Docker에 올린 프로그램은 scp로 파일을 외부로 전송하는 것이다. 그런데, UnKnownHostException, connection refused, ssh 문제 등 수 많은 다양한 에러들을 확인하고 드디어! 해결했다.

이 글은 내가 접한 모든 에러들은 제쳐두고, 그래서 제대로 사용하는 방법! 을 정리한다.

1.2.를 하기 전 공통사항

- Dockerfile에 Host와 연결할 포트를 설정한다.

아래 캡쳐화면은 22번을 Host 와 연결할 포트로 지정한 것이다.

ex) EXPOSE 22

- Dockerfile을 이용하여, Docker Image를 생성한다.

$docker build --tag [docker image 명(소문자여야 함)]:[Version 번호] [Dockerfile 경로]

ex) $docker build --tag dockerimage:1.0 .

※ docker image 소문자로 안적어서 몇 번 틀렸었음

1. docker run 명령어로 외부 포트 연결

- docker run 을 이용하여, image에 대한 Docker Container 의 create 및 start를 동시에 실행할 수 있다.

$docker run -P [host 포트]:[container 포트] [그 외 옵션] [docker이미지]

ex)$docker run -P 2000:22 --env JAVA_OPTS="-DBOOTSTRAP_SERVER=127.0.0.1:9092 -DTOPIC=topic" dockerimage:1.0

※ --env 는 도커를 통해 실행하는 프로그램에 대한 각종 환경설정을 제공한다. ENV로 설정한 환경 변수는 RUN,CMD,ENTRYPOINT에 적용된다.

2. Docker Engine API 를 이용하여 외부 포트 연결

- docker 에서는 API 또한 제공한다.

https://docs.docker.com/engine/api/v1.41/#operation/ContainerCreate

Docker Engine API v1.41 Reference

docs.docker.com

Docker API 를 이용하여, docker를 실행시키려면 다음과 같은 속성들을 추가해야 한다.

※ Docker API에서는 run 으로 한번에 create 및 start를 할 수 없으므로, Container 생성 후 Container 시작을 진행해야 한다.

아래 속성은 Create Container 할 때, Body에 작성해야 하는 것들이다.

* ExposedPort 설정

* HostConfig의 PortBindings 설정

위 속성 2가지 전부 설정해줘야 한다. (처음에 HostConfig의 PortBindings를 확인하지 못하고 ExposedPort만 했다가 여러번 UnknownHostException을 만났다.)

ex)

{
   "Env":[
      "JAVA_OPTS=-DBOOTSTRAP_SERVER=172.30.1.2:9092 -DTOPIC=topic"
   ],
   "Image":"dockerimage:1.0",
   "ExposedPorts":{
      "22/tcp":{
         
      }
   },
   "HostConfig":{
      "PortBindings":{
         "22/tcp":[
            {
               "HostPort":"2000"
            }
         ]
      }
   }
}

이것저것 문제 다 겪고 막상 해결하면 별 것 아닌 것 같은데, 한 번 문제 터지기 시작하면 끝도 없이 꼬이는지... 후... 정리했으니깐 다음엔 덜 헤매겠지...

※ 자바로 scp를 전송하는 코드가 궁금하다면... 아래 클릭

2022.07.05 - [etc] - [JAVA] JAVA 로 SCP 실행하는 방법 (jSch 라이브러리)

[JAVA] JAVA 로 SCP 실행하는 방법 (jSch 라이브러리)

JAVA로 command 명령어를 작성할 수 있다. ProcessBuilder 를 이용하면 되는데, 나는 처음에 ProcessBuilder를 이용하여 scp를 실행하려고 하였다. 그런데, ProcessBuilder 를 이용해 scp를 사용하려면, password..

tbmaster.tistory.com

[Maven] Maven 프로젝트 실행가능한 Jar 파일 만들기

tbMaster — Fri, 1 Jul 2022 17:53:36 +0900

내가 Spring boot가 아닌 일반 Maven Project를 실행가능한 Jar 파일로 만들기 위해 겪었던 고생을 작성해본다.

나의 Maven 프로젝트의 상황

- java8

- 외부 라이브러리가 포함되어 있음(kafka-client, jsch 등)

- 웹이 아닌 java 프로젝트

첫번째 시행착오

Java 프로젝트 구현 끝내고, 그냥 maven install 하여, jar 파일 실행

결과

Main 클래스를 찾을 수 없다고 나옴

* 아래 캡쳐화면은 maven project에서 mvn install 실행 후, 생성된 jar 파일을 실행했을 때 나온 에러 메시지로 Manifest 속성이 없다고 나온다.

두번째 시행착오

Main클래스를 찾으려면, Manifest가 있어야 한다고 해서, Maven에 Manifest를 plugin으로 추가하였다.

[ Manifest 추가 ]

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <configuration>
        <archive>
            <manifest>
                <mainClass>Main</mainClass>
                <addClasspath>true</addClasspath>
                <addExtensions>true</addExtensions>
            </manifest>
        </archive>
    </configuration>
</plugin>

결과

dependency 한 외부 라이브러리를 찾지 못함

* 아래 캡쳐 화면은 java.lang.NoClassDefFoundError 에러 메시지로, jsch 라이브러리를 프로젝트에서 사용하고 있는데, 찾지 못한다는 얘기다.

최종

Manifest만 plugin 한 경우에는 프로젝트에서 사용하는 외부 라이브러리가 자동적으로 추가되지 않는다고 한다.

그래서 dependency한 외부 라이브러리를 자동으로 추가해주기 위해 plugin을 추가하였다.

[ 외부 라이브러리 자동으로 추가할 수 있도록 plugin 설정 ]

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-shade-plugin</artifactId>
        <executions>
            <execution>
                <phase>package</phase>
                <goals>
                    <goal>shade</goal>
                </goals>
            </execution>
        </executions>
    </plugin>
</plugins>

결과

잘된다!!

pom.xml 파일에 작성한 plugins

참고 사이트

https://www.devkuma.com/docs/maven/maven-jar-plugin-%EC%8B%A4%ED%96%89-%EA%B0%80%EB%8A%A5%ED%95%9C-jar-%EC%83%9D%EC%84%B1/

Maven 입문 | Java 응용 프로그램 개발 | maven-jar-plugin 실행 가능한 Jar 생성

앞장에서 프로그램의 실행은 간단히 했지만 아직 완전하지 않다. target 폴더에 패키지된 Jar 파일이 생성되었지만, 이를 그대로 실행하려고 하면 동작하지 않는다. 예를 들어, 아래와 같이 명령을

www.devkuma.com

https://huskdoll.tistory.com/561

Maven Build java.lang.NoClassDefFoundError 처리

Maven으로 build할때 별다른 설정없이 build하면 내가 개발한 프로그램에서 사용하는 jar파일이 같이 묶이지 않습니다. (한마디로 내가 mysql DB에 접속하는 프로그램을 짜서 빌드하면 mysql-connector-java-

huskdoll.tistory.com

항상 springboot만 쓰다가 이렇게 springboot 가 아닌 프로젝트를 단순하게라도 진행하면, 모르는게 더 많고, 해결하는데 더 오래걸리는 것 같다 ...

이제라도 springboot 가 아닌 mven project의 실행가능 jar 파일 생성을 알아서 다행이다! 라고 나를 위로해야징..