프로그래밍 검색 결과

83개 발견
  1. 미리보기
    2019.06.07

    스프링 부트 2.0 2/e 마이크로서비스와 리액티브 프로그래밍

  2. 미리보기
    2019.05.07

    Mastering Spring 5.0

  3. 미리보기
    2018.11.18

    Vagrant 관련 이슈 글 모음

  4. 미리보기
    2018.11.13

    Eclipse에서 Darkest Dark Theme 적용 후 추가로 해줄것

  5. 미리보기
    2018.11.09

    Eclipse와 Github 연동(2) - github에서 프로젝트 받기

  6. 미리보기
    2018.11.09

    Eclipse와 Github 연동(1) - 프로젝트를 github에 올리기

  7. 미리보기
    2018.11.05

    Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (10) - 예외처리

  8. 미리보기
    2018.11.05

    Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (9) - XplatformView 분석

다음의 내용은 에이콘출판사의 나온 스프링 부트 2.0 2/e 마이크로서비스와 리액티브 프로그래밍(원서 제목은 Learning Spring Boot 2.0 Second Edition) 책을 일고 실습해가면서 몇몇 수정한 부분들에 대한 기록이다. 이전글인 Mastering Spring 5.0때와 상황이 비슷하다.   

이 책에서 사용한 Spring Boot 버전은 2.0.0.M5 이고 2019년 6월 7일 현재 이 글을 쓰는 시점에서 내가 사용하고 있는 Spring Boot 버전은 2.1.5.RELEASE 이다  

이전 글과 마찬가지로 순서는 책의 순서와는 맞지는 않으며 차후 수정이 계속 이루어질 것이며 수정과정에서 순서가 맞춰질수도 있다. Mastering Spring 5.0 때는 9장 공부하는 시점부터 문제가 생겼지만 이 책은 6장에서부터 문제가 시작되었다(사실 발생된 Chapter는 중요하진 않다. 실습하면서 문제가 생기는 시점은 책에서 Spring Cloud와 관련된 내용을 다루기 시작하는 시점에서부터 생기는거여서..)

 

● Gradle 에서 Spring Cloud Greenwich Dependency 설정

 

이 책의 254 페이지부터 스프링 클라우드 스트림 관련 설정이 소스 코드에 반영이 되어야 한다. 예전 글인 Mastering Spring 5.0 에서는 Maven 기반의 프로젝트로 샘플 코드가 만들어져 있었으나 이 책의 경우는 Gradle 기반의 프로젝트로 샘플 코드가 만들어져 있다. 그래서 단순히 책의 255 페이지에 있는 compile 구문만 추가해도 라이브러리가 추가되지 않는다. Mastering Spring 5.0 때와 마찬가지로 Spring Cloud Greenwich 설정을 Gradle에서 해주어야 라이브러리 다운로드가 가능하다. 다음의 내용을 build.gradle에 추가해주자.

 

buildscript {
    dependencies {
        classpath "io.spring.gradle:dependency-management-plugin:1.0.2.RELEASE"
    }
}

apply plugin: 'io.spring.dependency-management'

dependencyManagement {
    imports {
        mavenBom 'org.springframework.cloud:spring-cloud-dependencies:Greenwich.RELEASE'
    }
}

apply plugin: 'io.spring.dependency-management' 부분은 실습을 위해 Spring Boot Gradle 프로젝트를 만드는 과정에서 기본적으로 추가되어있을수 있다(내경우에는 그러했다) 이미 설정되어 있으면 하지 않아도 된다. buildscript, dependencyManagement 항목이 build.gradle의 어느 위치에 있어야 하는지는 정해져 있는건 없다(자신이 넣고 싶은 위치에 넣으면 된다는 뜻) 위의 내용을 넣고 책의 255 페이지에 있는 compile 부분을 build.gradle 에 추가하면 된다(정상적으로 처리되지 않았을 경우 책에서 실습한 RabbitMQ 관련 코드 부분들이 에러가 발생하기 때문에 정상적으로 라이브러리가 추가되었는지 아닌지 확인이 가능하다) 

 

이 글을 쓴 뒤에 책을 계속 읽어나가니 이 부분에 대한 설명이 책의 256 페이지에 있었다. 그러나 책에서 사용하는 스프링 클라우드 릴리스 트레인인 Finchley의 경우는 Spring Boot 2.0.X에 맞춰져 있어서 Spring Boot 2.1.X에는 맞지가 않다. 책과 같은 방법으로 이를 구현하려 할 경우 buildscript의 springCloudVersion 항목을 'Greenwich.REALEASE' 로 주면 된다.

 

● 257 페이지에 있는 CommentController 클래스 소스 코드의 CounterService 클래스에 대해..

 

CommentController 클래스 소스 코드를 보면 CounterService  클래스 객체를 멤버변수로 사용하고 있는데 CounterService 클래스는 이 샘플 프로젝트에서 실제 존재하는 클래스가 아니다.(github의 프로젝트 소스를 봐도 이 클래스 소스는 존재하지 않는다. github에 올라와 있는 프로젝트 소스에서 CommentController 클래스 소스를 보면 책과는 다르게 나와있다.) CounterService 관련 부분은 실습할때는 코딩하지 않도록 한다.

 

● 299 페이지 서킷 모니터링의 Hystrix

 

책에서는 299 페이지의 서킷 모니터링에서 Hystrix에 대한 설명을 하고 있다. Hystrix 설정에 대해서는 문제점은 없는데 다만 http://localhost:8080  주소를 브라우저로 한번도 접근하지 않은 상태에서 Hystrix Dashboard를 통해 http://localhost:8080/actuator/hystrix.stream 을 통해 모니터링을 시작하면 화면이 loading 만 나오고 아무 반응이 없다. 그래서 http://localhost:8080 주소를 브라우저로 한번 접근해야 hystrix 에서 모니터링 화면이 나오게 된다.

그러나 이 책에서 보면 Hystrix의 인위적인 장애상황을 테스트 하기 위해 CommentSilmulator 클래스를 수정해서 Comment가 자동으로 등록이 되는 작업과 http://localhost:8080 으로 접근한 효과를 나타내기 위해 HomeController의 index 메소드를 호출하고 있다. 그렇기 때문에 CommentSimulator 클래스를 수정한뒤에 simulator profile로 Images MicroService를 실행하게 되면 당연 Hystrix Dashboard 화면에서 브라우저로 http://localhost:8080 을 접근하지 않았어도 모니터링이 되는 화면이 나와야 하는데(CommentSimulator 클래스에서 HomeController의 index 메소드를 호출하고 있기 때문에..) 그러지를 않고 있다. 그래서 중단점을 걸어서 확인을 해보니 CommentSimulator 클래스를 통해 실행이 될 경우 Images MicroService에 있는 CommentHelper 클래스의 getComments 메소드가 실행되지 않는 것으로 확인이 되었다. 이 메소드에 HystixCommand 어노테이션을 걸었기 때문에 이 메소드가 실행이 안되면 Hystix Dashboard에서 모니터링이 되지 않는 것이다. 그러나 브라우저로 http://localhost:8080 으로 접근할 경우 CommentHelper 클래스의 getComments 메소드가 실행되는 것으로는 확인이 되었다. 이 차이가 왜 발생하는지는 현재는 파악하지 못한 상태이다. 

트랙백을 확인할 수 있습니다

URL을 배껴둬서 트랙백을 보낼 수 있습니다

다른 카테고리의 글 목록

프로그래밍/컴퓨터 서적 After Service 카테고리의 포스트 목록을 보여줍니다

Mastering Spring 5.0

2019.05.07 17:45

다음의 내용은 에이콘출판사의 Mastering Spring 5 책을 읽고 실습해나가면서 몇몇 수정한 부분들에 대한 기록이다. 책이 출판될 당시의 Spring Boot 관련 버전과 내가 책을 구매한 시점에서 사용되는 Spring Boot 관련 버전이 다른 관계로 인해 실습 코드에서 변화되는 부분이 있어서 이에 대한 기록을 남겨두려 한다.

 

이 책에서 사용한 Spring Boot 버전은 2.0.0.M1 이고 2019년 5월 7일 현재 이 글을 쓰는 시점에서 내가 사용하고 있는 Spring Boot 버전은 2.1.4.RELEASE 이다(당근 Springframework 버전도 차이가 나게 되는데 책은 5.0.0.RC1을 사용하고 있으나 내가 사용하고 있는 Springframework의 버전은 5.1.6 이다)

 

순서는 책의 순서와는 맞지는 않으며 차후 수정이 계속 이루어질 것이며 수정과정에서 순서가 맞춰질수도 있다(현재 이 책의 9장을 공부하던 도중에 이 문서를 작성해두어야겠다 는 생각이 들어서..)

 

9장 전까지는 실습하는데 있어서 큰 문제가 없었는데 9장의 클라우드로 넘어가면서 책의 내용으로 실제 실습을 진행해보니 맞지 않는 부분이 발생하기 시작했다. Spring Cloud의 경우는 Spring Boot 2로 넘어가면서 라이브러리 관리의 변화가 발생한 부분이 있었다. 그러다보니 pom.xml 에서의 설정이나 사용방법이 바뀐 부분이 생기게 되었다.

 

● 스프링 클라우드 컨피그 서버와 클라이언트 dependency 설정

 

책의 399페이지에 스프링 클라우드 컨피그 서버의 maven dependency 설정과 404 페이지와 405 페이지에 걸쳐서 스프링 클라우드 컨피그 클라이언트의 maven dependency 설정이 있는데 스프링 클라우드 컨피그 서버의 경우 399 페이지에 있는 설정만으로는 관련 어노테이션이 있는 jar를 갖고 오지 못한다. 405 페이지에 있는 의존성 관리 내용을 추가해 줘야 jar를 갖고 올 수 있다. 그러나 405 페이지에 있는 Dalston 버전은 Spring Boot 1.5.X과 호환성이 이루어지기 때문에 Spring Boot 2.X 버전에는 맞지 않는 현상이 있다. 그래서 Spring Boot 2.X에서 사용할 때는 Greenwich 를 사용하면 된다. 다음과 같이 설정해주면 된다

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-dependencies</artifactId>
      <version>Greenwich.RELEASE</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

● management.security.enabled 에 대해서

 

책의 401 페이지에서 이 항목에 대해 설정하는 내용이 있는데 별도의 설명이 없어서 나름 알아보게 되었다. 이 항목은 Spring Actuator와 Spring Security 이 두가지와 연관이 되어 있는데 Spring Actuator와 Spring Security를 동시에 사용할 경우 Spring Actuator에서 제공하는 몇몇 URL(정확한 용어로는 Endpoint)은 로그인 아이디와 비밀번호를 입력해야만 해당 화면을 볼 수 있게 된다. 별다른 설정을 안하면 Spring Security가 만드는 default 계정(아이디가 USER 이고 패스워드는 Spring Boot App이 실행되는 시점에 만들어진다)으로 로그인 해야만 볼 수 있게 되는데 이러한 기능을 사용하지 않을 경우 management.security.enabled 속성을 false로 지정해주면 된다. 그러나 Spring Security를 사용하지 않으면 이 속성의 값이 true/false 여부와는 상관없이 이 기능이 동작하지 않는다(즉 Actiator에서 제공되는 모든 URL을 별도의 인증과정 없이 볼 수 있다)

그러나 문제는 Spring Boot 2.X에서는 이 설정이 없어졌다(실제 Spring Boot Document를 보면 목차중에 Customizing the management server port 항목에서 이 설정에 대한 설명이 있는데 1.X 버전에는 이 설정에 대한 설명이 있지만 2.X 버전에서는 Customizing the management server port 항목에서 이 설정에 대한 설명이 빠져 있다.)

이 부분은 Spring Security에서 /actuator/** 경로로 접근하는 것에는 특정 Role(ex : ACTUATOR)이 있는 사용자만 접근이 되도록 설정하고 application.properties 에서 management.endpoint.health.roles 항목에 방금 언급했던 특정 Role을 지정해주면 된다. 관련 자료는 여기여기를 클릭하면 알 수 있다(첫번째 링크에서 두번째 링크를 같이 걸어놓았다) 그러나 이러한 설정을 일절 해주지 않으면 로그인 관련 인증 기능은 동작하지 않는다.

그러나 로그인 여부와는 상관없이 해당 Endpoint에 대한 접근제어 설정도 가능하다. 무슨 뜻이냐면 내가 로그인을 하든 안하든 모든 사용자에게 모든 Endpoint에 대한 접근 허용/금지, 특정 Endpoint에 대한 접근 허용/금지 설정이 가능하다. Spring 2.X 버전에서는 JMX를 통한 Endpoint는 shutdown을 제외하고는 모두 접근이 허용되어 있으나 web을 통한 접근은 health와 info를 빼고는 접근이 금지되어 있다. 이러한 설정을 수정할려면 management.endpoints.web.exposure.include 항목과 management.endpoints.web.exposure.exclude 항목을 이용해서 설정하면 된다. 예를 들어 다음과 같이 설정하면

management.endpoints.web.exposure.include = httptrace,logfile

management.endpoints.web.exposure.exclude = health

httptrace와 logfile은 각각 /actuator/httptrace 와 /actuator/logfile로 접근이 가능하며 health는 접근할 수 없게 된다.

전체를 의미하는 것으로 *을 사용할 수 있는데 만약 다음과 같이 사용하면

management.endpoints.web.exposure.include = *

management.endpoints.web.exposure.exclude = httptrace,logfile

httptrace와 logfile을 제외한 모든 Endpoint가 각각 /actuator/해당 Endpoint 이름 으로 web에서 접근이 가능해진다

(주의할 점이 있는데 properties 파일이 아닌 yml 파일로 환경설정을 할 경우 *를 설정할때는 "*" 이렇게 쌍따옴표로 감싸줘서 설정해줘야 한다)

 

Endpoint를 접근할때 앞에 /actuator란 경로가 붙는데 이것은 management.endpoints.web.base-path 항목이 default로 /actuator로 설정되어 있어서 그렇다(바꿔말하면 이 값을 바꿔주면 바꾼 경로로 접근이 가능하다)

 

● curl -X POST http://localhost:8080/refresh

 

책의 407 페이지를 보면 스프링 클라우드 버스에 대한 설명을 하면서 properties 파일의 항목 값을 변경했을 경우 이를 반영하기 위해 다음의 URL을 접근하도록 설명되어 있다. 그러나 막상 접근을 시도하면 404 Not Found로 나오게 되는데 그 이유는 위에서 설명한 Endpoint 경로가 앞에 /actuator가 붙게끔 기본적으로 설정이 되어 있기 때문이다. 그리고 위에서 설명했듯이 management.endpoints.web.exposure.include 항목에 refresh를 넣어주어서 Endpoint의 접근을 허용해주어야 한다. 그러나 이것만으로는 실제 동작이 이루어지지 않는다.

변경된 사항이 적용될려면 @RefreshScope 어노테이션이 붙어줘야한다. 책의 경우를 들자면 message 항목을 변경했기 때문에 message 항목을 출력하는 MessageController에 다음과 같이 붙어줘야 한다

@RestController 
@RefreshScope 
public class MessageController { 
    ... 
}

이렇게 해준뒤에 curl 명령어를 통해 갱신해주면 정상동작되는것을 확인 할 수 있다.

 

management.endpoints.web.exposure.include 항목에 대한 설정은 bootstrap.properties 에 해도 되고, Spring Cloud Server가 git 저장소에서 불러오는 application.properties 파일에서 해도 된다.

 

● 스프링 클라우드 버스를 사용해 구성 변경 전파

 

책의 408 페이지를 보면 스프링 클라우드 버스를 사용해 구성 변경 전파를 설명하는 항목이 있다. 구성이 변경되었을 경우 위에서 설명한 /actuator/refresh Endpoint를 각각 스프링 클라우드 클라이언트에서 실행해서 구성이 변경된 것을 적용하는게 아니라 RabiitMQ를 이용해서 일괄적용 하는 방법을 설명하는 부분이다. 이 부분에 대한 설명을 읽어보면 409 페이지에 있는 spring-cloud-starter-bus-amqp dependency 만 추가하는 것으로 모든게 다 되는거 마냥 설명하고 있는데 그렇지가 않다. 

이 지점에서 생각해보자. 클라우드 서버와 클라우드 클라이언트가 RabbitMQ를 매개체로 삼아서 구성 변경을 전파하려 한다면 당연 클라우드 서버도 RabbitMQ와 연동을 해야 한다. 그런데 여기서는 그러한 내용이 빠져 있다. 그리고 Spring Boot에서의 RabbitMQ의 설정 부분이 빠져있다(클라우드 서버든 클라우드 클라이언트든 RabbitMQ 를 연동하기위한 구체적인 설정 부분(RabbitMQ 서버의 ip 주소, 사용자명, 패스워드 등을 설정하는부분)이 있어야 한다) 이에 대한 부가설명은 쓰기엔 너무 길어서 일단 2개의 링크를 걸어두니 참조해서 설정하길 바란다. 이 설정 방법으로 구성 변경 사항이 모든 클라우드 클라이언트에 전달된 것을 테스트로 확인했다

 

Spring Cloud Config Server 및 Bus RabbitMQ 동기화

Spring Cloud Config Client 및 Bus RabbitMQ 동기화

 

지금부터는 위의 블로그에는 없는 내용을 설명하겠다. 

 

책 410 페이지를 보면 구성변경을 전파하기 위해 스프링 클라우드 클라이언트 중 하나에다가 다음의 Endpoint를 요청하고 있다.

 

curl -X POST http://localhost:8080/bus/refresh

 

그러나 위에서 설명했다시피 Endpoint 경로 앞에 /actuator 가 붙어야 한다. 그리고 refresh가 아닌 bus-refresh를 실행해야 한다. 그러다보니 위에서 스프링 클라우드 클라이언트에 설정했던 management.endpoints.web.exposure.include 항목에 refresh를 설정했듯이 bus-refresh도 같이 설정해야 한다

management.endpoints.web.exposure.include = refresh,bus-refresh

 

그래서 최종 요청 명령은 다음과 같이 된다

 

curl -X POST http://localhost:8080/actuator/bus/bus-refresh

 

그리고 스프링 클라우드 서버의 application.properties 에 다음의 설정을 추가한다

spring.cloud.bus.enabled = true

근데 이 설정은 default가 true 여서 설정을 하지 않아도 동작할거라 본다(Spring Boot Reference 문서에 보면 저 설정값이 default가 true이다. 그러나 테스트를 해보질 않아서 확인해보진 않았다)

 

나는 이부분에 대한 실습을 할때 docker에 rabbitmq:management-alpine 이미지를 컨테이너로 올려서 실습을 진행했다. 이 이미지를 사용하면 rabbitmq 서버의 관리자 화면을 브라우저를 통해 볼 수 있게 되는데 관리자 화면을 통해 connection을 보게 되면 하나의 인스턴스당 2개의 connection이 생성되는 것이 확인이 됐다(책의 예를 들어 설명하자면 spring cloud server 인스턴스 1개, microservice-a 인스턴스가 2개가 실행되기 때문에 RabbitMQ에서 connection은 총 6개가 생기는 것을 확인했다) 근데 이게 맞는건지 모르겠다. 근데 또 다시 rabbitmq 서버를 다시 재부팅해서 확인해보면 connection이 1개만 생기는 것으로 확인이 되어서 rabbitmq를 모르는 상태에서 보다보니 이 부분은 더 알기가 어려웠다

 

● Feign 라이브러리의 dependency 설정

 

책의 412 페이지를 보면 페인(Feign)을 사용하기 위해 pom.xml에 artifactId를 spring-cloud-starter-feign을 사용하도록 되어 있으나 현재는 spring-cloud-starter-openfeign 으로 바뀌었다.

 

● Ribbon 사용의 변경

 

책의 416 페이지를 보면 pom.xml에 립본(Ribbon) 라이브러리의 의존성을 추가하는 부분이 있다. artifactId를 spring-cloud-starter-ribbon을 사용하고 있으나 이 부분은 spring-cloud-starter-netflix-ribbon 으로 바뀌었다. 

 

책의 416 페이지를 보면 application.properties에 다음의 설정을 하는 부분이 있다.

random-proxy.ribbon.listOfServers=http://localhost:8080,http://localhost:8081

이 설정에 대한 구체적인 설명이 없어서 이 설정을 그대로 이용했을때 애로사항이 있었다. 처음 겪었던 애로사항은 random-proxy가 무엇인가였다. spring-cloud-starter-netflix-ribbon 을 추가했는데도 저 random-proxy를 application.properties에서 예약어로 잡히질 않았다. ribbon 이하의 설정 항목은 예약어로 잡히고 있으나 저 random-proxy는 잡히질 않았다. 그래서 알아보니 저 부분은 예약어가 아니었다. 책의 416 페이지를 보면 다음의 내용이 있다.

@FeignClient(name="microservice-a")
@RibbonClient(name="microservice-a")
public interface RandomServiceProxy

여기 설정을 보면 @RibbonClient 어노테이션에 name을 microservice-a로 주는게 있는데 바로 이 microservice-a를 random-proxy 대신 작성해야 한다. 그래서 다음과 같이 작성해야 한다.

microservice-a.ribbon.listOfServers=http://localhost:8080,http://localhost:8081

또 하나의 애로사항은 listOfServers 에 설정하는 값이다. 나는 이 설정값을 봤을때 properties 파일에서 해당 property에 ,(콤마)로 연결하며 서버 ip와 port 번호를 설정하길래 이것이 배열인줄 알았다. 그래서 application.yml 파일로 이 값을 설정할때 다음과 같이 했었다. 

microservice-a:
  ribbon:
    listOfServers:
      - http://localhost:8080
      - http://localhost:8081

yml 문법에서는 배열을 표기할때 -(하이픈)을 앞에 주어서 배열을 선언하게끔 되어 있다. 그러나 이렇게 설정을 하니 Spring Boot 어플리케이션에서 여기에 설정한 값을 찾지를 못하였다. 그래서 이에 대한 검색을 해보니 이게 배열이 아니었다. 즉 ,로 연결된 단일 문자열로 이 프로퍼티 항목이 값을 받아들이고 있었던 것이다. 그래서 이 부분을 yml로 설정할때는 다음과 같이 해야 된다.

microservice-a:
  ribbon:
    listOfServers: http://localhost:8080, http://localhost:8081

 

● Eureka 설정 변경

 

책의 423 페이지를 보면 유레카(Eureka) 라이브러리를 pom.xml에 설정하는 부분이 있다. 책에서는 artifactId를 spring-cloud-starter-eureka 로 하고 있지만 이걸로 하는게 아니라 립본과 마찬가지로 spring-cloud-starter-netflix-eureka-client로 설정해야 한다(netflix가 언급이 되는 식의..)

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

마찬가지로 책의 421 페이지와 같이 유레카 서버를 만들면 라이브러리가 다음과 같이 추가된다

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>

책의 425 페이지에서 설명하는 유레카와 서비스 소비자 마이크로서비스 연결 항목에서도 위에서 설정한것과 같이 spring-cloud-starter-netflix-eureka-client를 사용해야 한다

 

● Eureka 사용하면서 알아낸 내용

 

책에 나와있는대로 Eureka 서버를 구성하면 브라우저에서 http://localhost:8761로 Spring이 제공하는 유레카 메인 화면을 볼 수 있다. 이 화면에서 보면 Instances currently registered with Eureka 항목에 Application 항목으로 MICROSERVICE-A가 2개(책에 나와 있는대로 설정해서 실행하면 microservice-a가 8080 포트와 8081 포트에 바인딩 된 상태로 2개)가 올라와 있고 SERVICE-CONSUMER가 1개 올라와 있다. 그리고 MICROSERVICE-A에 보면 STATUS 항목에 UP(2)로 표시되면서 localhost:microservice-a:8080과 localhost:microservice-a:8081에 링크가 걸려있다. 이 링크를 각각 클릭해보면 localhost:8080/actuator/info와 localhost:8081/actuator/info 로 이동하게 되는데 이 URL로의 접근이 되질 않는다. 이유는 스프링 클라우드 버스 실습을 위해 위에서 언급했던 management.endpoints.web.exposure.include 항목을 refresh와 bus-refresh로 설정해서 그런거였다. 그러나 원래 이 설정을 안하면 기본적으로 이 항목은 info와 health는 기본값으로 들어가게 되어 있다. 그래서 info와 health를 수동으로 추가해줘야 한다.

그러나 이 항목의 변경은 RabbitMQ를 이용한 refresh 대상이 되질 않는다. 이유는 위에서 얘기했다시피 변경사항을 적용시킬려면 @RefreshScope 어노테이션을 붙여줘야 하는데 application.yml 파일을 수정하는 것은 @RefreshScope 어노테이션의 감시대상에는 들어가고 있지 않기 때문이다(이 부분도 개념적으로 좀 1차적으로 정리해보자면 프로그래머가 만든 비즈니스 로직일 경우 그 로직을 직접 구현하는 쪽에다가 @RefreshScope 어노테이션을 붙이면 변경사항 적용이 가능하겠지만 application.yml 과 같은 스프링 설정과 관련된 변경사항일 경우엔 @RefreshScope 어노테이션을 붙일 마땅한 장소가 없다. 그렇기 때문에 변경사항 적용에 대한 부분은 어디까지나 비즈니스 로직쪽에 한정을 두는 것이 어떨까 하는게 나의 1차적인 결론이다) 

 

● Spring Cloud Sleuth AlwaysSampler Bean 선언

 

책의 437 페이지를 보면 스프링 클라우드 슬루스 설정과 이에 대한 Bean 생성에 대한 코드가 있다. pom.xml에 의존성 설정하는 부분은 맞지만 페이지의 하단에 있는 @Bean 어노테이션을 통한 AlwaysSampler Bean을 생성하는 코드는 Spring Cloud 2.0 으로 넘어가면서 Spring에서 제공하는 AlwaysSampler를 사용하는 것이 아니라 Brave에서 제공하는 Tracing Library를 사용하는 것으로 바뀌었다.

(관련내용)그래서 이에 대한 코드 변화가 발생하였다. microservice-a, service-comsumer, zuul-api-gateway-server의 Spring Boot Application 클래스(main 메소드가 있는 클래스)에 다음과 같이 코딩해준다

@Bean
public Sampler sampler() {
  return Sampler.ALWAYS_SAMPLE;
}

이렇게 코딩해주면 책의 로그 관련 설명에 대한 부분을 볼 수 있다. 이 부분도 부가 설명을 하자면 로그 내용이 동일하지는 않다. 다만 이 책에서 설명하는 핵심 내용인 요청을 추적하는데 사용되는 값에 대한 확인은 가능하다.

 

● Zipkin 서버 구축 및 이에 대한 설정과 연동

 

책의 441 페이지를 보면 Spring Boot 기반하에서 Zipkin 서버를 독자적으로 구동하는 방법이 나오는데, 이 부분이 개인적으로 파악하고 정리하는데 시간이 오래걸렸다. 맨 먼저 발생한 지점은 441 페이지를 보면 Spring Boot 프로젝트를 start.spring.io에서 만들때 Zipkin UI, Zipkin Stream, Stream Rabbit 이렇게 Dependency를 선택하는 그림이 있는데 문제는 현재 이 dependency 들이 존재하지 않았다는 점이다. 그래서 그림에서와 같이 Spring Boot의 버전을 1.5.2로 낮춰서 해보면 나올수 있을까 싶어서 이렇게 해보았지만서도 나오지를 않았다. 그래서 프로젝트를 만들때 lombok, devtools, actuator 만 추가해 놓고 수동으로 추가로 넣을수 있게끔 일단 만든 상태에서 조시해보았다. 구글에서 검색한 내용도 책과는 별 차이는 없었다. 대신 책과는 달리 검색을 해보면 pom.xml에 dependency를 넣는 부분이 text로 되어 있기 때문에 어떤 groupId와 artifactId를 사용해야 하는지는 확인할 수 있었다. 내가 참조한 게시물은 Spring Cloud and Spring Boot, Part 2: Implementing Zipkin Server For Distributed Tracing 글을 참조해서 만들어갔다. 이 글은 Spring Boot 2.1은 아니었지만 그래도 2.0.X를 사용하고 있었기 때문에 현재 Spring Cloud를 GreenWich로 사용하고 있는 나로서는 적합한 내용일것 같았다. 그러나 이렇게 했는데도 문제는 존재한게 있었다. 위의 글에서와 같이 pom.xml에 zipkin 관련 설정을 해두고 442 페이지에 있는 @EnableZipkinServer 어노테이션을 붙이면 이 어노테이션이 deprecated 된 것으로 나온다. 그리고 @EnableZipkinServer 어노테이션이 2개가 존재하는 것을 알 수 있다.(이 글을 쓰는 시점에서는 Zipkin 서버를 Spring Boot 를 통해 구현하지는 않았기 때문에 관련 소스를 지워서 패키지를 알 수는 없지만 위의 링크된 글대로 zipkin 관련 라이브러리를 pom.xml을 설정한 뒤에 IDE에서 @EnableZipkinServer를 타이핑 해보면 deprecated 된 것과 그렇지 않은거 이렇게 2개가 나타난다) 첨엔 deprecated 되지 않은 어노테이션을 붙여봤는데 Spring Boot로는 9411 포트는 열려져 있지만 콘솔 로그를 면 이 Zipkin Server가 8080 포트로 열리고 있었다. 그래서 http://localhost:9411 로는 브라우저에서 접근이 안되었고 http://localhost:8080 으로는 브라우저에서 접근이 되어서 책의 442 페이지와 같은 화면을 볼 수 있었다. 이것을 어떻게든 고쳐볼려고 여러모로 검색해보고 시도해봤지만 실패하고 말았는데 결국 이러한 작업을 접게끔 만들어준것은 deprecated 된 @EnableZipkinServer 어노테이션의 소스에 있는 javadoc 설명이었다. 여기 설명을 보면 다음의 내용이 있다.

 

Custom servers are possible, but not supported by the community. Please use our
 https://github.com/apache/incubator-zipkin#quick-start default server build first.

 

Zipkin Custom Server는 지원하지만 커뮤니티에서는 지원하지 않는다는 뜻이었다. 즉 기술적으로는 Zipkin Custom Server를 구축하는 것에는 문제는 없지만 이에 대한 기술적인 지원은 커뮤니티에서 하지 않는다는 것이다. 아마 Zipkin Custom Server 구축에 대한 기술적인 통로를 열어주면서 이에 대한 여러가지 형태의 Zipkin Server 구현체가 나오다보니 이에 대한 기술지원이 한계에 이르러서 그런듯 하다. 그래서 Custom Server를 만들때 이에 대한 문제점이 발생할 경우 그것은 전적으로 개발자 책임이란 식의 얘기를 덧붙이고 있다. 그러면서 마지막으로 Custom Server는 가능하지만 지원해주지는 않는다(custom servers are possible, but not supported)란 말로 마무리 짓고 있다. 그리고 stackoverflow 에서도 이에 대한 언급을 찾은것도 있었다.(여기  글에 대한 MyTwoCents의 답글에 Brian Devins 의 댓글을 보면 위의 설명과 같은 맥락으로 해설할 수 있다. 커뮤니티에서 이 Custom Server 제작과 관련된 기술을 열어둔 뒤 얼마나 이것에 대한 기술질문 들에 대해 시달렸으면 @EnableZipkinServer 사용을 권장하지 말라. 커뮤니티에 부담이 된다 라고 언급했을까..) 그래서 @EnableZipkinServer 어노테이션을 통한 Zipkin Server 구현은 접고서 Zipkin을 만들어서 배포하는 zipkin.io가이드라인에 따라 Zipkin Server를 열었다. Docker Image로도 Zipkin Server를 제공해주기 때문에 나는 Docker로 Zipkin Server를 열었다. 다음은 내가 이 실습을 위해 열은 Zipkin Server를 구동시키는 docker-compose.yml 파일 소스이다.

 

version: '2.1'

services:
  zipkin:
    image: openzipkin/zipkin
    container_name: zipkin
#    volumes:
#      - /vagrant_hosts/docker/alpine_nginx_docroot:/docroot:rw
    environment:
      - RABBIT_ADDRESSES=10.10.20.6:5672
      - RABBIT_USER=admin
      - RABBIT_PASSWORD=admin
    restart: always
    ports:
      - "9411:9411"
    networks:
      dockernet:
        ipv4_address: 10.10.20.7
networks:
  dockernet:
    external: true

여기서 보면 openzipkin/zipkin 이란 이미지를 사용하고 있고 이 이미지로 열었을 경우 zipkin 이란 이름으로 container가 만들어지도록 했다. 그리고 환경변수로 RABBIT_ADDRESSES, RABBIT_USER, RABBIT_PASSWORD 이렇게 3개가 있는데 이 3개의 항목은 RABBITMQ 서버와 관련된 항목이다. 책의 443 페이지를 보면 spring-cloud-sleuth-zipkin 라이브러리와 함께 spring-cloud-starter-bus-amqp 를 같이 추가해주고 있다. spring-cloud-starter-bus-amqp 의 경우는 스프링 클라우드 버스와 관련된 실습을 할때 microservice-a 어플리케이션에 이미 의존성을 추가해둔 상태이지만 443 페이지에서는 service comsumer 와 zuul-api-gateway-server 에도 추가해주도록 되어 있다. 이것은 sleuth를 통해 만들어진 추적 로그를 RabbitMQ를 통해서 Zipkin Server에 전달하기 위해 그런것이다. 책에서 보면 442 페이지에 스트림 레빗이 이와 같은 역할을 하는 것이었지만 현재 스프링은 더이상 이에 대한 지원은 하지 않기 때문에 Zipkin Server 에서 RabbitMQ로 연결하는 설정을 해주어야 하는 것이다. 그래서 이 3개의 환경변수 설정이 추가로 필요하게 되었다.

그리고 책에는 언급이 안되어 있는데 우리가 만든 microservice-a, service-comsumer, zuul-api-gateway-server가 zipkin과 연동이 되어야 하는데 이 부분에 대한 언급이 없다. 즉 어떤 zipkin server와 연동해야 할 것인지, 보내는 방법은 무엇을 사용할 것인지 등에 대한 설정을 해야 하는데 그에 대해서는 application.yml에 다음의 설정을 해주도록 하자

 

spring:
  zipkin:
    base-url: http://localhost:9411/
    sender:
      type: rabbit
    enabled: true
  rabbitmq:
    host: localhost
    username: admin
    password: admin
  sleuth:
    sampler:
      probability: 1

spring.zipkin.base-url에는 zipkin 서버 url을 설정해준다. spring.zipkin.sender.type 에는 rabbit을 설정함으로서 rabbitmq 서버를 통해 sleuth 를 통해 만들어진 추적 정보를 보내주게 된다. 그리고 해당 RabbitMQ 서버는 spring.rabbitmq에 관련 정보를 언급해두도록 하며 마지막의 spring.sleuth.sample.probability는 추적 로그를 샘플링 하는 비율이다. 예를 들어 이 값을 1로 설정하면 요청된 모든 사항에 대한 전체 샘플링을 하겠다는 뜻이다. 그러나 이것을 0.1로 할 경우 전체 요청의 10%만을 샘플링하겠다는 뜻이다. 이 샘플링 된 것들만이 Zipkin을 통해 추적이 가능하기 때문에 전체 사항을 추적해볼려면 1로 설정하는 것이 좋을듯 하나 실제로는 매번 요청할때마다 샘플링해서 zipkin 서버로 보내주어야 하기 때문에 이에 대한 부하도 분명 있을수 있다. 이것은 운영하면서 결정지어야 할 듯 하다. 지금은 테스트 용도니까 1로 주는 것으로 했다. 이러한 설정들을 마친뒤 docker-compose를 통해 Zipkin Server를 구동하고 각각의 Spring Boot 어플리케이션을 실행해보면 책에서 보여주고 있는 Zipkin UI 를 통해 이를 확인할 수 있다.

 

※ RabbitMQ Server 설정과 관련하여 이상하게 생각할 사람이 있을것 같아 추가로 더 언급해두고자 한다. 일단 나는 RabbitMQ Server와 Zipkin Server를 Docker 기반에서 실행되도록 하였다. 이 Docker의 경우는 Windows 10에 VirtualBox와 Vagrant를 설치한 후 이를 통해 centos 7 vagrant 컨테이너가 실행이 되는 기반에서 여기에 Docker를 설치하여 운영했다. RabbitMQ 서버에는 ip를 10.10.20.6 

으로 주고, Zipkin Server에는 10.10.20.7로 주었다. 그래서 Zipkin에서 RabbitMQ Server를 연동할때는 RABBIT_ADDRESSES 환경변수에 해당 ip를 직접 설정해주었다. 그러나 Spring Boot Application의 경우 Windows 10에서 실행되다보니 각 Server의 ip를 통해 접근하지는 않았고 대신 해당 Server가 사용하는 기본 port를 port forwarding 설정을 해줌으로써 localhost로 설정

하더라도 port forwarding 을 통해 기본 포트가 해당 Server로 통신이 이루어지도록 했다. 그래서 application.yml에서는 RabbitMQ Server를 언급할때 10.10.20.6이 아닌 localhost로 지정할 수 있었다. 

 

● @EnableHystrix 에 대하여

 

책의 446 페이지를 보면 Hystrix를 통한 마이크로서비스의 내결함성 구현에 대해 설명하고 있는데 이걸 할려면 의존성 정보를 다음과 같이 주는 식으로 수정해주어야 한다

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>

그리고 책에서 보면  hystrix 자동설정을 @EnableHystrix 어노테이션을 사용하도록 되어 있다. 그러나 Spring Cloud 문서를 보면 @EnableHystrix가 아닌 @EnableCircuitBreaker 어노테이션을 사용하도록 되어 있다.

그러면 @EnableHystrix와 @EnableCircuitBreaker의 차이점을 언급해야 할 듯하다. 마이크로서비스의 내결함성을 위해 이른바 Circuit Breaker 패턴을 사용하게 되는데 @EnableHystrix는 Hystrix를 통해 Circuit Breaker 패턴을 구현하는 것이고, @EnableCircuitBreaker는 Circuit Breaker 패턴 구현을 Hystrix로 구현한 것이다.(이게 말이야 방구야..?)

이 두 문장의 의미는 현 시점에서는 동일하게 비쳐지지만 엄밀하게 따지면 다른 점이 있다. @EnableHystrix는 Hystrix에 우선을 둔다. 즉 Hystrix를 통해 Curcuit Breaker 패턴을 구현하기 때문에 ClassPath에 Hystrix 라이브러리가 없으면 동작하지 않는다. 그러나 @EnableCircuitBreaker 는 Circuit Breaker 패턴에  우선을 둔다. 즉 Circuit Breaker 패턴을 구현할 수 있는 라이브러리만 있다면 동작이 가능한 것이다. 즉 Circuit Breaker를 구현하기 위해 Hystrix를 사용한다면 이 두 어노테이션은 동일한 동작을 한다. 그러나 Circuit Breaker를 구현하기 위해 Hystrix가 아닌 다른 라이브러리(예를 들어 finagle이나 javaslang-circuitbreaker 등)을 사용한다면 @EnableCircuitBreraker는 사용 가능하지만 @EnableHystrix는 사용할 수 없게 된다.(관련 내용은 여기에서 참조했다) 그리고 여기를 보면 Spring Cloud 에서 조차도 @EnableHystrix을 삭제(deprecated가 아닌)하려는 움직임이 있어 보인다.

약간 추가적인 설명을 더 하자면 이 책에서 실습으로 사용되는 라이브러리는 Netflix가 사용하는 마이크로서비스 라이브러리가 그 중심이다. 그렇기 때문에 @EnableHystrix 대신에 @EnableCircuitBreaker 로 더 범용적인 설정을 사용하게끔은 하겠지만 그 이후에 사용하는 어노테이션인 @HystrixCommand 는 그대로 갈 것이다(@EnableHystrix가 없어진다고 해서 @HystrixCommand 도 없어지지는 않는다는 의미임) 왜냐면 @HystrixCommand는 Circuit Breaker 패턴을 Hystrix로 구현하겠다고 결정되어진 이후에 동작하는 어노테이션이기 때문이다. 만약 위에서 잠깐 언급한 finagle 이나 javaslang-circuitbreaker를 Spring Cloud가 지원하게 된다면 @HysrixCommand도 @EnableCircuitBreaker와 같이 좀더 범용적인 어노테이션으로 바뀔것이라 생각한다.

 

● Hystrix 모니터링

 

책에서는 다루지 않는 내용인데 Spring Cloud Greenwich Reference 문서를 보면 Hystrix를 모니터링 할 수 있는 Hystrix DashBoard를 설명한 부분이 있어서 이를 한번 구현해 보았다. 관련 내용은 여기를 보고 만들어봤다. 다만 이걸 만든뒤 실습을 할려면 책을 보고 만들었던 프로젝트에서 수정해야 할 것이 생겨서 이에 대한 설명을 하고자 한다.

우리가 Hystrix를 테스트 할 때는 microservice-a 인스턴스를 띄우지 않은 상태에서 service-consumer 인스턴스를 띄운뒤에 http://localhost:8100/add 메소드를 실행시켜 service-consumer 인스턴스가 microservice-a 인스턴스의 random 메소드를 실행시킬수 없게끔 동작 실패를 유도하는 식으로 Hystrix를 테스트했다. 여기서 우리는 hystrix를 모니터링 해야 하는 대상을 잡아야 하는데 hystrix를 모니터링 해야 하는 대상은 service-consumer 인스턴스이다(hystrix 관련 설정을 service-consumer에다가 했으니까..) 그래서 hystrix 모니터링 인스턴스가 service-consumer 인스턴스를 모니터링을 해야 하기 때문에 이를 모니터링 하기 위해 service-consumer 프로젝트에 몇몇 수정을 가해야 할 부분이 있다.

  1. Hystrix 모니터링은 Actuator 기반으로 움직이기 때문에 service-consumer의 pom.xml 에 Spring Actuator를 추가 해야 한다(책에서 스프링 클라우드 버스를 설명할때 이 Actuator를 microservice-a 의 pom.xml에만 추가했기 때문에 Spring Actuator에 대한 dependency 태그를 service-consumer의 pom.xml에 추가해야 한다)
  2. Spring Actuator를 이용해서 하는 것이기 때문에 Hystrix 모니터링에서 service-consumer로 접근할 Endpoint를 지정해야 한다. Hystrix 모니터링에서 사용할 Endpoint는 hystrix.stream 이다. 그래서 service-consumer의 application.yml에 다음의 내용을 추가해준다.
    management:
      endpoints:
        web:
          exposure:
            include: info, health, refresh, bus-refresh, hystrix.stream

    info와 health는 default로 include 되는 항목이고 refresh와 bus-refresh는 위에서 스프링 클라우드 버스때  설명했단 Endpoint이다. 마지막으로 hystrix.stream 이 바로 Hystrix 모니터링을 하기 위해 추가된 Endpoint이다

이렇게 한 뒤에 microservice-a 인스턴스는 일절 띄우지 말고 service-comsumer 인스턴스와 hystrix 모니터링 인스턴스를 띄운 상태에서 hystrix 모니터링 화면을 띄우고 http://localhost:8100/add 메소드를 반복적으로 호출해보자. 그러면 모니터링 화면에서 실패한 횟수가 점점 올라가는데 단지 몇번 실패한 걸로는 circuit이 close 된 상태를 유지하지만 한 20여번 실패하게 되면 circuit이 open 된 상태로 바뀌면서 아예 호출 자체를 막아버린다. 그런 뒤에 다시 microservice-a 인스턴스를 띄운 후 http://localhost:8100/add 메소드를 호출해서 정상 동작을 하게끔 해주면 다시 circuit이 close 되는 것을 확인할 수 있다.

 

 

 

트랙백을 확인할 수 있습니다

URL을 배껴둬서 트랙백을 보낼 수 있습니다

다른 카테고리의 글 목록

프로그래밍/컴퓨터 서적 After Service 카테고리의 포스트 목록을 보여줍니다

Docker 관련으로 된 글을 보던중 Vagrant를 알게 되어 Vagrant를 설치하게 되었다. Vagrant에 대한 설치는 도커 Docker 기초 확실히 다지기 이 글을 보고 Vagrant를 설치했다. 그러나 Vagrant를 설치 및 운영하다 보면 이슈사항이 나올것 같아서 개인 기록 및 공유 차원에서 이 글에 기록해두고자 한다. 그래서 이 글은 그런 이슈 사항이 나올때마다 갱신될 예정이다(근데 Vagrant 이건 발음이 어떻게 되나..베이그랜트? 바그랜트?)


1. Windows 10에서 위에 링크되어 있는 글을 보고 설치한뒤 centos/7 으로 VM을 하나 만들어서 vagrant ssh를 실행하니 vagrant@127.0.0.1: Permission denied (publickey,gssapi-keyex,gssapi-with-mic). 에러가 발생하면서 ssh에 대한 접속이 이루어지지 않았다. 이것에 대해 검색해보니 환경변수로 VAGRANT_PREFER_SYSTEM_BIN을 만든 뒤 이 변수에 값을 0을 주면 해결이 된다고 해서 이 방법을 써서 해결이 되었다. VAGRANT_PREFER_SYSTEM_BIN 환경변수가 궁금한 사람은 여기를 클릭해서 보면 된다.


2. 1번의 문제를 해결한뒤 ssh를 접속해보니 vagrant 란 계정을 디폴트로 만든뒤에 이 계정으로 접속이 되었다. 그러나 root 계정이 아니기 때문에 yum 명령을 이용해서 프로그램을 설치할려면 sudo 명령을 같이 써야 한다(ex: sudo yum ...) 이것이 불편해서 root 계정의 패스워드가 무엇인지 찾아봤는데 기본적으로 root 계정의 패스워드는 vagrant로 설정하고 있다. 그러나 현재는 Vagrantfile에서 root 계정의 패스워드를 설정하는 방법을 찾지는 못한 상황이다. VM을 만드는 시점에 root 계정의 패스워드를 지정하면 편할텐데 아직은 모르겠다.


3. Windows 10에서 Vagrant를 설치하니 Vagrant에서 box로 통하는 이미지들(docker로 하다보니 용어가 이미지로 되어버렸다)은 받아지는 위치의 기준이 C:\Users\사용자 계정\.vagrant.d 이 디렉토리 밑에 boxes라는 디렉토리에 받아지고 있었다. .vagrant.d 디렉토리가 Vagrant의 Home 디렉토리 역할을 하고 있다. 이 Home 설정 개념이 Java나 Maven과는 약간 다른데 Java나 Maven의 경우 JAVA_HOME과 MAVEN_HOME은 Java나 Maven이 설치된 디렉토리를 가르켜야 하지만 Vagrant의 경우는 그렇지가 않다(실제로 나는 Vagrant를 D:\Vagrant에 설치했다) 이 이미지를 받는 디렉토리가 C 드라이브에 있을 경우 C 드라이브 용량이 작아지는 상황이 벌어질수 있어서 위치를 바꾸었다. 위치르 바꿀때는 환경변수로 VAGRANT_HOME에 지정하면 된다(나는 VAGRANT_HOME을 D:\Vagrant_VMS\.vagrant.d 로 지정했다) 이때 주의점이 있다. VAGRANT_HOME에 매핑되는 디렉토리를 Vagrant가 설치된 디렉토리(나의 경우로 예를 들면 D:\Vagrant 가 된다)의 하위 디렉토리로 설정하면 안된다. Vagrant를 설치하면 Vagrant가 설치된 디렉토리는 일반 계정으로는 접근이 안되기 때문에 읽거나 쓰지 못하는 상황이 벌어져서 이미지를 다운로드 받지 못하게 된다. 그래서 위에서 언급한 설정으로 Vagrant 설치 디렉토리가 아닌 D:\Vagrant_VMS\.vagrant.d로 지정했다.


트랙백을 확인할 수 있습니다

URL을 배껴둬서 트랙백을 보낼 수 있습니다

다른 카테고리의 글 목록

프로그래밍/기타 카테고리의 포스트 목록을 보여줍니다

Eclipse에서 Darkest Dark Theme 적용 후 Git과 연동하면서 색상이 보기 흉하게 바뀌는 상황이 있었다. 이유는 Git으로 파일 관리를 하면서 파일의 상태가 바뀌었을때 이에 대해 표현하는 방법때문이었다. 예를 들면 파일을 수정할 경우 Commit이 아직은 안되어 있는 상태이기 때문에 Uncommited 인데 이때 이 자원을 나타내는 background 색상이 흰색으로 설정되어 있어서 전체적으로 검은색 테마에서 배경색을 흰색으로 주다보니 어울리지 않아 보기 싫은 상황이 생겼다. 암튼 Darkest Dark Theme를 사용하면서 배경색이 흰 색으로 되어 있는 부분은 튀어 보이는 상황이 벌어지는 것이 있는데 일단 예를 들은 경우를 수정할려면..(차후에 이런 상황들이 또 일어나면 여기에 정리할 예정이다)


1. Window -> Preference -> General -> Appearance -> Color And Fonts 에 간 뒤 Git 항목의 하위 항목으로 Uncommited Change(Background)를 찾아보면 현재 색상이 흰 색으로 되어 있는데 이것을 검정으로 바꿔준다.


2. Git의 ignored 파일에 속한 파일들도 그 배경색이 흰 색이기 때문에 Window -> Preference -> General -> Appearance -> Color And Fonts 에 간 뒤 Git 항목의 하위 항목으로 Ignored Resource (Background) 를 찾아서 이 색상을 검정으로 바꿔주면 된다.

트랙백을 확인할 수 있습니다

URL을 배껴둬서 트랙백을 보낼 수 있습니다

다른 카테고리의 글 목록

프로그래밍/Java 카테고리의 포스트 목록을 보여줍니다

지난 글에서는 Eclipse와 git을 사용해서 github에 자신이 만든 프로젝트를 올리는 방법에 대해 설명했다. 이번엔 그 반대의 상황으로 github에 올라와 있는 프로젝트를 자신의 eclipse workspace로 받는 방법에 대해 설명하고자 한다. 환경은 지난글과 동일한 환경이어서 환경에 대한 얘기는 생략하기로 하겠다. 대신 지난번 글을 보고 그대로 따라한 상황에서 이번 글을 보고 그대로 따라하고 싶으시다면 지난번 글에 올라간 자신의 프로젝트를 eclipse workspace에서 삭제해주길 바란다. 이번 글로 설명할때 프로젝트가 자신의 workspace에는 없다는 가정에서 할 것이기 때문에 eclipse workspace에 등록되어 있는 github 에 등록된 자신의 프로젝트를 삭제하고 진행하길 바란다(이때 프로젝트에서 마우스 우클릭하여 나오는 context menu에서 Team -> disconnect 를 선택하여 git과의 연동을 끊은 뒤에 프로젝트가 있는 worksppace 디렉토리에서 해당 프로젝트 디렉토리가 삭제가 된 상태로 삭제 처리를 해주어야 한다)


먼저 해야 할 것은 지난 글을 통해 자신의 프로젝트 소스가 올라간 github repository에 가서 주소를 얻어와야 하는 일이다. 아래의 그림은 github repository를 브라우저로 방문했을때 나타나는 화면이다.



여기서 빨간 박스로 표시된 Clone or download 버튼을 클릭하면 위의 그림과 같이 Clone with HTTPS 타이틀을 가진 조그만 레이어 화면이 나오는데 이때 파란색 박스로 표시된 버튼을 클릭하여 현재 방문한 repository의 URL을 복사하여 문서편집기에 일단 붙여넣자. 그리고 탐색기를 통해 eclipse에서 현재 사용중인 workspace 디렉토리로 이동한 뒤 마우스 우클릭하여 나오는 context menu에서 Git Bash Here 메뉴를 선택한다.



여기서 중요한 점은 이 작업을 하게 되는 디렉토리다. 이 부분은 이전 글과는 차이점이 있다. 이전 글에서는 Git Bash 화면을 띄우는 위치가 해당 프로젝트의 디렉토리였다. 그러나 이번글은 프로젝트가 없는 상태에서 github에 등록된 자신의 프로젝트를 받는 것이기 때문에 이전 글과 같이 해당 프로젝트의 디렉토리로 이동할 수 없는 상황이다. 그렇기 때문에 이 작업을 할때는 이 프로젝트를 받게되는 eclipse workspace 디렉토리에서 해야 한다. 이 작업을 하게 되면 해당 디렉토리에서 Git Bash Prompt 화면을 띄워주게 된다. 이 상태에서 다음의 명령어를 입력해주면 된다. 


git clone remote repository 주소


여기서 remote repository 주소 란 것은 아까 위에서 github에서 복사하여 문서편집기에 붙여넣은 주소이다. 아래의 그림은 다음의 명령어를 실행한 화면이다.



위의 화면을 보면 명령어를 remote repository에 접속하여 해당 remote repository에 올라와 있는 것을 받게 된다. 이때 remote repository 이름(여기서는 samplemvn이 된다)으로 디렉토리를 만들어 받게 된다. 현재 이 명령어를 실행할때 eclipse의 workspace 디렉토리에서 실행했기 때문에 workspace 디렉토리에 remote repository 이름으로 디렉토리를 만들어서 받게 된다. 이때 git local repository도 같이 생성해주기 때문에 이전 글에서 했던 git init 명령을 하지 않는다. 아래의 화면은 이 작업을 진행한 뒤의 workspace 디렉토리를 탐색기로 본 화면이다. samplemvn이란 디렉토리가 만들어져있다. 그래서 git으로 할 작업은 모두 다 끝났다.(벌써? 이걸로?)



그러면 이걸로 진정 끝난걸까? 아니다. 끝난것은 git으로 할 작업뿐이다. eclipse의 workspace 디렉토리에 해당 repository를 다운로드 받으면 eclipse에서 바로 사용할 수 있을까? 전혀 아니다. 왜냐면 workspace 디렉토리에 다운로드만 받은것 뿐이지 이것이 eclipse의 프로젝트로 등록되어진 상태는 아니기 때문이다. 그래서 지금부터는 이렇게 다운로드 받은 프로젝트를 eclipse에 등록하는 작업을 진행하고자 한다. 먼저 eclipse에서 다음과 같이 Package Explorer에서 마우스 우클릭하여 나오는 메뉴에서 import 메뉴를 실행한다.



Import 메뉴를 실행하면 아래의 화면과 같이 Import 화면이 나오는데 여기서 Git의 Projects from Git 선택한뒤 Next 버튼을 클릭한다.



Projects from Git을 선택하면 아래와 같은 화면이 나오는 데 여기서 Existing local repository를 선택한 뒤 Next 버튼을 클릭한다.



Next 버튼을 클릭하면 아래와 같은 화면이 나오는데 여기서 빨간 박스로 표시된 Add 버튼을 클릭한다.



Add 버튼을 클릭하면 아래의 화면과 같이 나타난다. 여기서 빨간 박스로 표시된 Browse... 버튼을 클릭하면 폴더 선택 화면이 나오는데 여기서 local repository 디렉토리를 선택한다. 그러면 이 디렉토리가 어떤것인가? 이전 글에서는 git init 명령을 실행하면 만들어지는 .git 디렉토리가 local repository 디렉토리였지만 지금 상황에서는 맞지 않는다. 그러면 이 디렉토리는 어디인가? 아까 git clone 명령을 실행해서 받은 디렉토리(remote repository 이름으로 된 디렉토리)의 하위 디렉토리를 보면 .git 디렉토리가 있다. 그 디렉토리를 선택해준다.



.git 디렉토리를 선택하면 아래 화면과 같이 선택한 .git 디렉토리가 화면에 보이게 되는데 이때 아래 화면과 같이 해당 .git 디렉토리를 체크 설정을 해준다. 그러면 화면이 나타날 당시엔 비활성화 되어 있는 Finish 버튼이 활성화가 된다. 아래 화면과 같이 설정해준뒤 Finish 버튼을 클릭한다.



Finish 버튼을 클릭하면 아래의 화면과 같이 선택한 local repository가 추가된다. 이때 아래 화면과 같이 추가된 local repository를 선택한 상태에서 Next 버튼을 클릭한다.



Next 버튼을 클릭하면 아래와 같은 화면이 나오는데 여기서 Import as general project를 선택한뒤 Next 버튼을 클릭한다.



Next 버튼을 클릭하면 이 진행과정의 마지막 단계로 프로젝트 이름을 설정하는 화면이 나온다. 프로젝트 이름을 입력한뒤 Finish 버튼을 클릭하면 eclipse에 프로젝트를 등록하는 모든 과정을 마치게 된다.



여기까지 진행해서 github을 통해 받은 프로젝트를 eclipse에 등록하는 과정을 마쳤다. 그러나 이것으로 끝난 것일까? 아니다. 아직 한가지 작업이 더 남았다. 아래의 화면을 보자.



위의 화면은 방금 등록한 프로젝트의 하위 구조를 열어보인 것이다. 이걸로 작업할 수 있을까? 불가능하진 않지만 불편하다. 이전 글을 통해 우리가 프로젝트를 github에 올렸을 때 Maven 기반의 프로젝트를 올렸는데 위의 화면은 Maven 프로젝트의 형태로 보이지 않는다. 이유는 우리가 이 프로젝트를 일반적인 Java 프로젝트로 등록했기 때문이다. 그래서 이 프로젝트를 Maven 기반 프로젝트로 변환해줘야 한다. 위의 그림과 같이 프로젝트에서 마우스 우클릭하여 나오는 context menu에서 configure 메뉴의 Convert to Maven Project 메뉴를 선택해준다. 그러면 프로젝트 구조를 Maven Project 구조로 바꿔주면서 아래의 화면과 같은 형태로 보여주게 된다.



이상으로 모든 과정이 끝났다. git 관련 명령을 실행하는 것도 이전 글에서와 같이 마찬가지로 Eclipse의 Team 메뉴를 통해 git 관련 명령을 실행할 수 있기 때문에 Git Bash 화면을 띄워서 작업하지 않아도 된다. 


이전 글에서와 마찬가지로 이것도 연동하는 과정에서 로그인 아이디와 비밀번호를 물어보는 상황이 나올수 있다. 이때는 github의 로그인 아이디와 비밀번호를 입력하면 된다.


트랙백을 확인할 수 있습니다

URL을 배껴둬서 트랙백을 보낼 수 있습니다

다른 카테고리의 글 목록

프로그래밍/기타 카테고리의 포스트 목록을 보여줍니다

개인적으로 eclipse와 github을 연동하면서 싫어하는 상황이 하나 있다. 그것은 Eclipse에서 git을 사용하려면 local repository 디렉토리를 설정해야 하는데 연동을 하게 되면 연동된 프로젝트들이 모두 local repository 디렉토리 밑으로 들어가게 되어서 실제로는 프로젝트 소스가 eclipse의 workspace에 존재하지 않게 된다. 이렇게 될 경우 동일한 workspace에 존재하는 여러 프로젝트들 중 git으로 공유되지 않은 프로젝트는 workspace 디렉토리에 있지만 디스크에 2군데에 존재하는 상황이 벌어진다. 이점에 있어서는 IntelliJ 가 잘되어 있는게 IntelliJ의 경우는 local repository를 특정 디렉토리로 설정하는 것이 아니라 공유 대상이 되는 Module 밑에 이 local repository를 두게 된다. 그래서 이클립스와는 달리 같은 소스가 2군데에 존재하는 상황은 벌어지지 않는다(git 연결을 더이상 안할려고 할 경우엔 IntelliJ에서 git과의 연동을 끊고 .git 디렉토리를 지워주면 끝이다) 그래서 이 글에서는 IntelliJ 처럼 Eclipse 프로젝트 디렉토리 밑에 git local repository를 두어서 연동하는 방법에 대해 써보고자 한다. 이 글에서 사용하는 프로그램은 Eclipse는 아니고 Eclipse 기반의 Spring Tool Suite 4(이하 STS로 하겠다)이지만 git을 연동하는것은 Eclipse나 STS 모두 EGit을 사용하기 때문에 같은 방법으로 사용할 수 있다.


이 방법으로 할 경우 먼저 git의 공식 사이트인 git-scm.com에서 자신의 운영체제에 맞는 git client를 설치해야 한다. git client를 설치하는 방법은 다른 블로그들에 이미 많이 소개되어 있어서 여기서는 소개하지는 않고 이것이 설치가 되어 있다는 상태에서 설명을 시작하도록 하겠다. 먼저 git의 remote repository를 만들어준다. github에서 자신이 만든 remote repository를 들어가면 이런 형태의 화면을 보게 될 것이다.



이 화면에서 빨간색 박스가 쳐져 있는 버튼을 클릭해서 현재 자신이 만든 remote repository의 주소를 복사한 뒤에 메모장 같은 문서 편집기에 붙여넣는다. 이 주소는 나중에 쓸 것이라서 일단은 다른데에 보관하는 차원에서 붙여넣어둔 것이다.


그 다음으로 remote repository에 올릴 프로젝트의 디렉토리로 이동한다. 여기서는 설명을 하기 위해 D:\workspaces\samplemvn 디렉토리가 Eclipse의 프로젝트 디렉토리라고 하겠다. 여기서 마우스 우클릭을 하면 다음과 같은 화면이 나타난다(이 프로젝트는 STS에서 Spring Starter Project 메뉴를 이용해서 만든 Maven 기반의 Spring Boot 프로젝트이다. 그래서 .gitignore 파일이 있다)



위에서 언급했던 Git Client를 설치했다면 마우스 우클릭시 다음과 같이 Git GUI Here란 메뉴와 Git Bash Here 란 메뉴가 나타날것이다. 여기서 Git Bash Here 메뉴를 선택한다. 그러면 이 폴더에 위치한 상태로 Git Bash 화면이 나타난다. 이 화면에서 다음의 순서대로 명령어를 입력해서 실행시켜 준다. 그러면 아래의 그림과 같이 나타난다.


  1. git init
  2. git add .
  3. git commit -m "commit message"
  4. git remote add origin 문서편집기에 붙여 두었던 github remote repository 주소
  5. git push origin master

 


위에서 나열한 명령어가 하는 작업에 대해 간략하게 설명하자면 git init이란 명령을 해서 현재 디렉토리를 기준으로 local repository를 만들게 된다. 이 명령을 하면 .git 폴더가 숨김 폴더 형태로 만들어지게 된다. git add . 을 실행해서 local repository에 보관되어 있는 것과 변경점이 있는 파일들을 index에 추가한다. 여기서는 local repository가 금방 만들어져 있는 상태여서 아무것도 없기 때문에 현재 디렉토리에 있는 모든 디렉토리와 파일이 추가된다. 그리고 git commit -m "commit message" 를 통해 index에 추가된 디렉토리와 파일을 commit 하게 된다. 위의 그림을 보면 Init Project 로 commit message를 설정해서 명령을 실행했다. 그리고 git remote origin remote repository 주소를 통해 remote repository를 추가한다. 여기서 사용하는 remote repository 주소는 아까 문서편집기에 붙여넣은 remote repository 주소를 사용한다. 그리고 이렇게 사용되는 remote repository 주소를 origin 이란 이름으로 remote repository에 추가한다. 그리고 마지막으로 git push -u origin master 를 통해 local repository에 있는 디렉토리와 파일들을 remote repository에 추가한다. 이렇게 자신의 프로젝트가 github에 방금 만들어놓은 remote repository에 들어가게 된다. 이 과정을 거친뒤에 github에 들어가면 다음과 같이 자신의 프로젝트 소스들이 들어가 있는 repository를 보게 된다. 



지금까지 한 과정은 github과의 연동을 전체 과정중 절반까지 한 것이다. 우리가 github 연동할 때 위에서 사용했던 Git Bash 화면으로만 할 것이면 전부 다 한것이지만 그렇게 할 경우엔 git 명령을 일일이 프롬프트 화면에서 명령어 입력하는 형태로 진행해야 하기 때문에 불편하다. Git Bash  화면으로 하는 것은 연동에 대한 초기화 작업만 진행하는 것이고 그 다음부터 commit, push, pull 등의 git 관련 명령을 실행하는 것은 eclipse에서 하는 것이 편하다. 실제 현재 상황을 설명하자면 git 과의 연동은 Git Bash 화면에서는 모두 끝이 났지만 eclipse에서는 아무런 연동이 되어 있지 않은 상황이다. 그래서 지금부터 하는 설명은 eclipse에서 git 명령을 할 수 있게 연동하는 과정을 설명하겠다. eclipse에서 Git Bash 화면을 통해 github과 연동되어 있는 프로젝트에서 마우스 우클릭을 하면 아래와 같은 context menu가 나오는데 이 메뉴에서 아래 그림과 같이 Team -> Share Project... 를 선택한다.



Share Project... 메뉴를 선택하면 아래의 그림과 같이 나타난다. 흔히 eclipse와 git 연동 관련 글을 보게 되면 이 과정에서 나오는 화면과는 다른 모습이 보일 것이다. 왜냐면 기존 글은 git을 연동하지 않은 상태에서 메뉴를 선택했기 때문에 local repository를 만드는 과정을 거치지만 우리는 이미 Git Bash 화면을 통해 local repository를 만들어놓은 상태이기 때문에 local repository 디렉토리(여기서는 .git 디렉토리)를 자동으로 인지하게 되어서 아래의 그림과 같이 나타난다. 아래와 같이 화면이 나온 상태에서 Finish 버튼을 클릭하면 Eclipse에서 Git을 연동한 과정이 모두 끝나게 된다.



이렇게 모든 과정을 진행한뒤 다시 eclipse 프로젝트에서 마우스 우클릭을 해서 Team 메뉴를 들어가보면 아래의 그림과 같이 Git 관련 명령을 사용할 수 있는 메뉴들을 볼 수 있게 된다. 이후부터 git 관련 작업은 Git Bash 화면이 아닌 eclipse의 Team 메뉴를 통해서 작업하면 된다.



이렇게 자신이 만든 프로젝트를 github과 같은 remote repository에 올리는 방법에 대해 설명했다. 지금까지 설명한 내용을 살펴보면 eclipse에서 local repository를 만든것이 아니라 Git Bash 화면을 통해 현재 프로젝트 디렉토리 하위에 만들었기 때문에 프로젝트 소스가 workspace에 존재하지 않는 그런 상황이 발생되지 않는다. 이 글에서는 자신이 만든 프로젝트를 remote repository에 올리는 방법에 대해 설명했고 다음 글에서는 remote repostory에 올라와 있는 소스를 자신의 eclipse workspace 디렉토리에 가져오는 방법에 대해 설명하겠다.


이 글에서는 언급하지 않았지만 연동하는 과정에서 로그인 아이디와 비밀번호를 물어보는 상황이 나오게 된다. 이때는 github의 로그인 아이디와 비밀번호를 입력하면 된다.


트랙백을 확인할 수 있습니다

URL을 배껴둬서 트랙백을 보낼 수 있습니다

다른 카테고리의 글 목록

프로그래밍/기타 카테고리의 포스트 목록을 보여줍니다

이번 글은 이 연재의 마지막으로 해당 템플릿에서의 예외처리에 대해 설명하도록 하겠다. 우리가 만든 Spring Application에서는 이런저런 이유로 예외가 발생할 수 있다. 비즈니스적인 로직으로 인해 발생하는 예외도 있고 Runtime 예외도 있다. 예외가 발생할 경우 try-catch를 이용해서 발생시점에서 해당 예외에 대한 처리를 할 수 있지만 비즈니스적으로 이러한 예외처리를 해야 하는게 아니라면 발생된 예외는 호출한 곳으로 계속 던져지게 된다. 단계별로 예외가 계속 던져지게 되면 최종적으로는 Controller 까지 도달하게 되며 Controller에서도 예외 처리를 안하게 되면 Controller 에서는 다시 예외를 던져서 Spring에서 정해져있는 ExceptionResolver 객체에서 이를 처리하게 된다. ExceptionResolver 객체에는 처리해야 할 예외 클래스와 이 예외를 보여줘야 할 View를 정해주기 때문에 해당 예외에 대한 출력이 가능해진다. 그러나 여기서는 ExceptionResolver 객체를 별도로 만들어 등록하지 않고 @ControllerAdvice 와 @ExceptionHandler 를 이용해서 예외를 처리하게 된다. 다음은 이러한 예외를 처리하는 GlobalExceptionHandler 클래스이다.


@ControllerAdvice
public class GlobalExceptionHandler {

	@ExceptionHandler(value={DataAccessException.class})
	public XplatformView processDataAccessException(DataAccessException ex){
		XplatformView xplatformView = new XplatformView("30", ex.getMessage());
		return xplatformView;
	}

	@ExceptionHandler(value={Exception.class})
	public ModelAndView processException(Exception ex){
		ModelAndView modelAndView = new ModelAndView();
		modelAndView.addObject("ErrorCode", "156");
		modelAndView.addObject("ErrorMsg", ex.getMessage());
		modelAndView.setViewName("errorView");
		return modelAndView;
	}
}


코드를 보면 클래스 레벨에 @ControllerAdvice 어노테이션을 붙이고 메소드 레벨에 @ExceptionHandler 어노테이션을 붙이고 있다. @ExceptionHandler 어노테이션에 처리해야 할 예외를 정의하게 되는데 예외를 하나의 메소드에서 여러개를 처리해야 할 경우 배열 형태로 정의해서 설정할 수 있다(코드에서도 보면 예외 클래스를 1개만 설정하고 있어도 표현하는 방법은 배열 형태의 {}를 사용해서 설정하고 있다) 세부 코드를 보면 예외를 설정해서 View로 표현하는 방법이 2가지의 방법으로 구현되고 있다. 하나는 이전 글에서 설명했던 글인 XplatformView 클래스 객체를 생성해서 이를 return 하는 방법이 있고, 다른 하나는 우리가 늘 익숙했던 코드인 ModelAndView 클래스 객체를 생성해서 여기에 ErrorCode와 ErrorMsg 란 이름으로 값을 설정한 뒤 이 객체를 return 하고 있다. 결과만 얘기하면 둘다 동일한 형태의 결과를 보여준다. 예전 글에서 XplatformView 클래스 코드에 대해 설명할 때 다음의 내용을 설명한 것이 있다.


if(!model.containsKey("ErrorCode")) {
	variableList.add("ErrorCode", ERROR_CODE_VALUE);
}

if(!model.containsKey("ErrorMsg")) {
	variableList.add("ErrorMsg", ERROR_MSG_VALUE);
}


XplatformView 코드를 보면 ERROR_CODE_VALUE와 ERROR_MSG_VALUE 멤버변수가 있고 이를 설정하는 생성자도 있다. GlobalExceptionHandler 클래스의 processDataAccessException 메소드는 XplatformView 생성자를 통해 이 멤버변수를 설정했고 위의 코드를 실행하는 시점에 model에 ErrorCode와 ErrorMsg 가 없을 경우 model에 ErrorCode와 ErrorMsg를 각각 key로 주어서 이 멤버변수 값이 들어가게 된다. 이러한 방법으로 processDataAccessException 메소드가 해당 예외에 대한 코드와 메시지를 설정하게 된다. 그러나 processDataAccessException 메소드는 model에 ErrorCode와 ErrorMsg를 설정한 상태에서 XplatformView에 전달되기 때문에 위의 코드가 실행이 되지 않는다. 만약 XPlatformView 생성자에서 에러코드와 에러메시지를 설정하고 model에도 ErrorCode와 ErrorMsg가 설정된 상태로 XplatformView에 전달되면 model에 있는 것으로 전달이 된다. 여기서는 예시로 DB 관련 예외인 DataAccessException 과 Exception 2개만 예로 들었지만 예외와 그 처리 방법에 따라 메소드를 늘려가며 작업하면 된다.


지금까지 Spring과 Xplatform을 연동한 템플릿에 대한 설명을 진행했다. 궁금한 내용이 있으면 댓글로 달아주길 바란다. 그리고 이것은 모든 상황에 대응할 수 있는 템플릿은 아니다. 이 템플릿은 Xplatform에서 제공하는 샘플 예제로 만들어놓은 템플릿이기 때문에 아주 기본적인 상황에서는 대응할 수 있지만 그거보다 확장된 상황에서는 대응할 수가 없다(내가 받은 Xplatform 예제엔 파일 업로드 기능이 없어서 이에 대한 내용을 템플릿에 구현하지를 못했다. 지인에세 물어본바로는 Xplatform도 Java단에서 MultipartRequest 로 받는다고 하기 때문에 XplatformArgumentResolver에서 MultipartRequest로 받아서 진행하면 될 것으로 생각한다) 그러니 적용시엔 커스터마이징 할 것을 생각하고 진행하길 바란다.


 1. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (1) - 개요

 2. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (2) - 사전지식

 3. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (3) - HttpServletRequestWrapper

 4. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (4) - Spring Controller에서 하려는 것

 5. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (5) - HandlerMethodArgumentResolver 분석(1)

 6. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (6) - HandlerMethodArgumentResolver 분석(2)

 7. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (7) - HandlerMethodArgumentResolver 분석(3)

 8. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (8) - HandlerMethodArgumentResolver 분석(4)

 9. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (9) - XplatformView 분석

 10. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (10) - 예외처리


트랙백을 확인할 수 있습니다

URL을 배껴둬서 트랙백을 보낼 수 있습니다

다른 카테고리의 글 목록

프로그래밍/Spring 카테고리의 포스트 목록을 보여줍니다

이전 글까지는 Xplatform에서 넘어온 DataSetList과 VariableList를 Controller의 메소드 파라미터에서 자바 객체로 변환해주는 HandlerArgumentResolver 인터페이스 구현 클래스에 대해 설명했다. 지금까지의 내용이 Xplatform에서 넘어온 데이터들을 Spring에서 사용하기 위해 적절하게 데이터를 변환한 작업이었고 지금부터 설명한 내용은 Spring에서 나온 데이터를 Xplatform에서 사용가능한 데이터로 변환하는 작업에 대해 설명하고자 한다. 이해를 돕기 위해 설명하자면 자바에서 제공하는 List 객체로 나온 결과물을 Xplatform에서 제공하는 DataSet 클래스 객체로 변환하는 것이다. 이 부분에서도 또한 Java의 Reflection 기능을 사용해서 변환하게 된다. 이전 글들에서 예기했던 DataSet 클래스 객체를 Java의 Collection 인터페이스 구현 객체로 변환할때 했던 설명들의 역방향이라고 생각하면 된다. 결과물이 List<Map<String, Object>> 객체일 경우 List 객체에 들어있는 Map 객체 갯수만큼 loop를 돌면서 Map 객체 하나하나를 DataSet의 레코드로 변환하는 것이다. Map의 key를 레코드의 컬럼 이름으로 설정해서 레코드를 만들게 된다. Map 객체가 아닌 POJO 스타일 Java 클래스 객체일 경우 클래스의 멤버변수를 레코드의 컬럼 이름으로 설정해서 해당 멤버변수의 값을 레코드의 컬럼값으로 넣게 된다. 이러한 개념을 알고 구체적인 내용을 보도록 하자.


먼저 현재의 상황에서는 Spring에서 Contoller를 통해 결과물을 출력할때 2가지의 클래스가 필요하다. 


  1. View 인터페이스를 구현한 클래스
  2. 1번의 클래스 객체를 생성하는 ViewResolver 인터페이스를 구현한 클래스


모든 상황이 반드시 이 2가지 클래스가 필요한 것은 아니다. Rest 방식의 경우는 HttpServletRequest의 Header 값을 통해 넘어오는 파라미터의 타입을 알아내어 그에 맞는 HttpMessageConverter를 이용해서 파라미터를 Java 클래스 객체로 변환하거나 또는 Java 클래스 객체를 해당 타입의 값으로 변환하기도 한다. 그래서 위에서 언급할때 현재의 상황 이란 단어를 사용했다. Xplatform의 경우는 XML로 전송하기 때문에 XML 관련 HttpMessageConverter를 이용해 객체를 만들거나 또는 객체를 XML로 변환할 수 있겠지만 이미 투비소프트에서 자신들이 정의한 DataSetList나 VariableList 등의 클래스로 변환을 해서 return 해주거나 또는 그 반대의 기능을 수행하는 PllatformRequest와 PlatformResponse 클래스를 제공하고 있기 때문에 굳이 HttpMessageConverter를 구현한 클래스를 별도로 만들 필요가 없다. 물론 구현에 대해 말리지는 않겠으나 투비소프트에서 정의한 XML에 대한 분석이 필요하기 때문에 이러한 쓸데없는 노가다를 피할려고 PlatformRequest나 PlatformResponse를 사용했다


Spring에서는 View인터페이스와 ViewResolver 인터페이스를 구현한 여러 클래스들을 제공하고 있다. 이러한 클래스는 추상클래스와 그렇지 않은 클래스들이 혼재되어 있는데 이 클래스들중에서 본인 용도에 맞는 클래스가 있으면 그걸 사용하면 되고 그런 클래스가 없을 경우 제공되는 추상클래스에서 상속받아 이를 구현하거나 추상클래스 상속받아서 해결될 문제가 아니면 해당 인터페이스를 구현한 클래스를 직접 만들어서 사용하면 된다. 여기서는 후자의 방법으로 진행했다(어떠한 클래스들이 있는지 궁금한 사람은 Spring API 문서의 이 두 인터페이스 관련 내용을 보면 알 수 있다.)


그러면 먼저 ViewResolver 인터페이스를 구현한 클래스 코드를 보도록 하자


public class XplatformViewResolver implements ViewResolver, Ordered {

	private int order = Ordered.LOWEST_PRECEDENCE;

	@Override
	public View resolveViewName(String viewName, Locale locale) throws Exception {
		// TODO Auto-generated method stub
		XplatformView xplatformView = new XplatformView();
		return xplatformView;
	}

	@Override
	public int getOrder() {
		// TODO Auto-generated method stub
		return order;
	}

	public void setOrder(int order) {
		this.order = order;
	}

}


이 클래스 소스를 보면 2개의 인터페이스를 구현하고 있는데 하나는 위에서 말한 ViewResolver 인터페이스이고 또 하나는 Ordered 인터페이스이다. Ordered 인터페이스를 구현한 이유는 좀 이따가 설명하기로 하고 ViewResolver 인터페이스에 대해 설명하도록 하겠다. ViewResolver 인터페이스는 1개의 메소드를 제공하는데 View 인터페이스를 구현한 클래스 객체를 return 해주는 resolveViewName 메소드이다. 이 메소드가 하는 일은 단순하다. view 이름과 locale 정보를 받아서 데이터를 보여주는 View 객체를 return 해주면 된다. 즉 우리가 클라이언트에 전달할 데이터를 담은 View 객체를 여기서 만들어서 return 해주면 된다. 그래서 코드도 단순하다. View 인터페이스를 구현한 클래스인 XplatformView 클래스 객체를 만들어서 return 해주기만 하면 된다. 그리고 Ordered 인터페이스를 구현한 이유는 ViewResolver 인터페이스를 구현한 클래스가 여러개일 경우 우선순위를 설정해야 하는데 이것을 하기 위해 Ordered 인터페이스를 구현했다. Spring에서는 ViewResolver를 여러개 설정할 수 있다. 우리가 표현할 데이터를 여러 다양한 클라이언트를 통해 표현해야 하기 때문에 해당 클라이언트에 따른 ViewResolver를 구현하므로 여러개를 설정할 수 있게 된다. 이때 어떤것을 가장 먼저 적용해야 하는지 우선순위를 정할 수 있다. 이를 위해서 Ordered 인터페이스를 구현했다. 이 인터페이스에서 제공하는 메소드는 getOrder 메소드 하나뿐이 없다. getOrder 메소드에서 설정된 우선순위 값을 return 해주면 된다.


ViewResolver는 View를 만드는 단순한 작업만 하기 때문에 따로 설명할 내용은 없다. Java 객체를 Xplatform에서 사용하도록 만드는 핵심 기능은 View에 있다. 그럼 위에서 보여준 클래스 코드인 XplatformViewResovler 클래스가 만들어주는 View인 XplatformView 클래스를 살펴보도록 하자. 대강의 윤곽은 다음과 같다.


public class XplatformView implements View {

	/**
	 * Xplatform의 작업결과가 성공적이었을때의 ErrorCode 값을 설정한다
	 */
	private final String ERROR_CODE_VALUE;

	/**
	 * Xplatform의 작업결과가 성공적이었을때의 ErrorMsg 값을 설정한다
	 */
	private final String ERROR_MSG_VALUE;

	public XplatformView() {
		this.ERROR_CODE_VALUE = "0";
		this.ERROR_MSG_VALUE = "";
	}

	public XplatformView(String errorCodeValue, String errorMsgValue) {
		this.ERROR_CODE_VALUE = errorCodeValue;
		this.ERROR_MSG_VALUE = errorMsgValue;
	}

	@Override
	public String getContentType() {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response)
			throws Exception {
		// TODO Auto-generated method stub
		String contentType = request.getHeader("Content-Type").startsWith("text/xml;") ? XplatformConstants.CONTENT_TYPE_XML
				: request.getHeader("Content-Type");

    	if(contentType == XplatformConstants.CONTENT_TYPE_XML) {
    		...
    	} else if(contentType == XplatformConstants.CONTENT_TYPE_CSV) {

    	}
	}

	...

}


위에서 보여주는 코드는 XplatformView 클래스의 전체 코드는 아니다. 설명에 필요한 부분만 남긴 것이며 설명할때마다 관련 코드는 그때그때 추가로 보여주도록 하겠다. 일단 이 클래스 코드를 보면 멤버변수로 ERROR_CODE_VALUE와 ERROR_MSG_VALUE가 있다. 이것은 Spring에서 Xplatform 관련 작업을 하면서 문제가 발생하여 예외가 발생했을 경우 이를 처리하기 위한 변수이다. ERROR_CODE_VALUE에는 에러 Code를 설정하고 ERROR_MSG_VALUE는 에러 메시지를 설정하게 된다. 이 변수들에 대한 설정은 생성자에서 하고 있다. 그러나 예외가 발생한 일이 없어서 작업 자체가 성공적으로 수행이 되면 파라미터가 없는 생성자를 이용해서 View를 생성함으로써 관련 코드와 메시지를 설정하고 있다. 이것에 대한 내용은 나중에 예외 관련 처리 글에 대한 설명에서 좀더 자세히 다루겠다. 지금은 이 변수들의 의미만 알아두고 넘어가자.


View 인터페이스의 핵심 메소드는 render 메소드이다. render 메소드에서는 3개의 파라미터를 받게 되는데 첫번째는 Controller의 메소드에서 설정한 Model 객체이고 두번째는 Controller의 메소드가 처리하고 있는 HttpServletRequest 객체이며, 세번째는 Controller의 메소드를 통해 출력하게 되는 HttpServletResponse 객체가 넘어오게 된다. 


처음으로 하는 작업은 해당 요청에 대한 content type을 request의 header에서 읽어오게 된다. content type을 읽어오는 이유는 content type에 맞춰서 출력하기 위함이다. 특별한 작업을 거치지 않는 한에는 content type은 text/xml; charset=UTF-8 로 넘어온다. 그래서 읽어온 header 값이 text/xml; 로 시작하면 XML 로 출력하는 것을 의미하는 뜻에서 Xplatform의 PlatformType 인터페이스를 상속받은 XplatformConstants 인터페이스의 상수인 CONTENT_TYPE_XML을 설정했다. 이 CONTENT_TYPE_XML은 PlatformType 인터페이스에 정의되어 있는 상수이다.


사실 이 View는 원래 목적에서 100% 구현된 것은 아니다. github을 통해 이 클래스의 render 메소드를 보면 contentType 변수가 XplatformConstants 인터페이스의 CONTENT_TYPE_CSV 일 경우에 대한 처리부분은 비어있다. 내가 Xplatform 전문 프로그래머가 아니어서 이 부분에 대한 지식이 약한데, Xplatform 전문 프로그래머인 지인의 말에 의하면 Xplatform은 출력할때 XML 포맷으로 출력하거나 또는 CSV 스타일로 출력할 수 있다고 한다. 근데 내가 가지고 있는 Xplatform 샘플 프로젝트는 CSV 형태로의 출력 기능이 구현되어 있지 않아 이 부분에 대한 구현을 할 수 없었다. 이 부분에 대해서는 투비소프트에서 이를 처리하는 jsp 소스를 받아 이를 구현해야 할 것임을 미리 밝혀둔다. 그래서 request의 content type이 xml이 아닌 경우 이 content type 값을 그대로 설정하도록 했다. (아마 추측에는 그냥 response stream에 CSV 형태의 문자열을 그대로 내려주면 될 것 같다는 추측은 해본다)


그러면 이제 XML인 경우 어떻게 처리하는지 알아보자. XML일 경우 다음의 코드를 실행하게 된다.


if(contentType == XplatformConstants.CONTENT_TYPE_XML) {
	VariableList variableList = new VariableList();
	DataSetList dataSetList = new DataSetList();
	HttpPlatformResponse httpPlatformResponse = new HttpPlatformResponse(response, XplatformConstants.CONTENT_TYPE_XML);

	if(model != null) {

		for(Entry<String, ?> entry : model.entrySet()) {
			String key = entry.getKey();
			Object object = entry.getValue();
			if(object instanceof Collection) {
				@SuppressWarnings("unchecked")
				DataSet dataSet = makeDataSet(key, (Collection<Object>)object);
				dataSetList.add(dataSet);
			} else {
				Variable variable = null;
				if(object instanceof Integer) {
					variable = new Variable(key, PlatformDataType.INT, (Integer)object);
				} else if(object instanceof Long) {
					variable = new Variable(key, PlatformDataType.LONG, (Long)object);
				} else if(object instanceof Float) {
					variable = new Variable(key, PlatformDataType.FLOAT, (Float)object);
				} else if(object instanceof Double) {
					variable = new Variable(key, PlatformDataType.DOUBLE, (Double)object);
				} else if(object instanceof Date) {
					variable = new Variable(key, PlatformDataType.DATE, (Date)object);
				} else if(object instanceof String){
					variable = new Variable(key, PlatformDataType.STRING, (String)object);
				} else if(object instanceof Variable) {
					variable = (Variable)object;
				} else {
					// model에 들어있는 클래스 객체중에 DataSet으로 변환할 수 없는 클래스 객체가 들어있는것은 bypass 하게끔 한다

					if(skipDataSet(object)) {
						continue;
					}

					// 객체의 멤버변수들 값을 읽어서 한 행짜리 데이터셋으로 return 하는 방법을 고민해보자
					DataSet dataSet = makeDataSet(key, object);
					dataSetList.add(dataSet);
				}
				if(variable != null) {
					variableList.add(variable);
				}
			}
		}

		// XplatformView를 만든다는 것은 그 이전단계까지는 예외없이 진행되었다는 뜻이기 때문에 Xplatform에서 읽어들일변수인 ErrorCode 와 ErrorMsg 변수에 작업이 성공했다는 내용을 설정한다
		// Controller에서 ErrorCode와 ErrorMsg를 설정한 것이 없으면 XplatformView에서 설정하도록 한다
		if(!model.containsKey("ErrorCode")) {
			variableList.add("ErrorCode", ERROR_CODE_VALUE);
		}

		if(!model.containsKey("ErrorMsg")) {
			variableList.add("ErrorMsg", ERROR_MSG_VALUE);
		}
	}

	PlatformData platformData = new PlatformData();
	platformData.setVariableList(variableList);
	platformData.setDataSetList(dataSetList);
	httpPlatformResponse.setData(platformData);
	httpPlatformResponse.sendData();

}


여기에서도 Java Reflection을 통해 Java에서 제공되는 클래스 객체를 Xplatform에서 제공되는 클래스 객체로 바꾸게 된다. 처음의 세 줄은 Xplatform 클라이언트에서 받게될 VariableList 객체와 DataSetList 객체를 생성하고 HttpServletResponse 객체를 넘겨서 Xplatform에서 제공하는 HttpPlatformResponse 객체를 생성하게 된다. 이때 XML로 출력할 것임을 설정하는 작업으로 XplatformConstants.CONTENT_TYPE_XML 상수를 같이 넘겨준다.  이렇게 출력과 관련된 기초작업을 마치면 본격적으로 model 안에 있는 데이터들을 그 성격에 따라 Variable 객체로 만들어서 VariableList 객체에 넣거나 또는 DataSet 객체로 만들어 DataSetList 객체에 넣으면 된다.


넘겨받은 model은 Map<String, ?> 구조이기 때문에 이에 대한 Entry객체가 들어있는 Set 객체를 이용해 반복적으로 Entry 객체 단위의 작업을 진행할 수 있다. Entry 객체를 통해 key와 value를 얻어오면 value로 얻어온 값이 어떤 타입인지을 알아내야 한다. 예전에 ArgumentResolver 에 대한 설명을 했을 당시 DataSet 클래스 객체는 Collection 인터페이스를 상속받은 인터페이스(List, Set)를 구현한 클래스 객체로 변환할 수 있었다. 마찬가지다. 지금은 이것의 반대방향으로 변환한다고 보면 된다. 즉 Collection 인터페이스 계열 객체이면 이를 DataSet 클래스 객체로 변환하는 것이다. 그래서 Collection 인터페이스 계열 객체이면(if(object instanceof Collection)) makeDataSet 메소드에 key와 해당 value를 넘겨서 DataSet 객체를 받은 뒤 이 DataSet을 위에서 만든 DataSetList 객체에 넣게 된다. Collection 인터페이스 계열 객체가 아니면 Java에서 제공하는 Type(ex:int, long, float, double 등)의 객체이거나 또는 사용자가 만든 VO 클래스 객체일 것이다. 그래서 Java에서 제공하는 Type의 객체일 경우 이를 Variable 객체로 변환하여 VaribableList 객체에 넣게 된다. Variable 객체로 만들때 지정하게 된 Variable 이름은 파라미터로 전달된 model 의 key 를 사용하게 된다. 변환해야 할 클래스 객체가 VO 클래스면 1개의 레코드를 가진 DataSet 클래스 객체로 변환하게 된다. model 파라미터에서 객체를 DataSet으로 변환할때는 model에서 사용했던 key를 DataSet 이름으로 사용하게 된다. 이 key는 나중에 Xplatform 코드에서 다음과 같이 사용하면 된다. 예를 들어 ds_output 이란 key로 Controller의 메소드에서 model에 결과를 저장했으면 Xplatform의 에서 ds_output 으로 DataSet 이름을 주면 된다(엄밀하게 말하면 ds_result=ds_output 이런 식으로 설정하게 된다. ds_output 이란 이름의 DataSet 을 서버에서 받아 Xplatform에 있는 ds_result DataSet에 전달한다는 의미로 해석하면 되겠다) 이 변환과정에서 사용되는 메소드로 makeDataSet 메소드를 별도로 만들어서 사용하고 있는데 이 부분에 대한 설명은 생략하도록 하겠다. 예전에 ArgumentResolver 메소드에서 사용했던 XplatformReflectionUtils 클래스의 메소드같이 Java Reflection을 이용해서 객체를 변환한다. 대신 ArgumentResolver 에서는 DataSet을 Java 객체로 변환했지만 이번엔 그 반대방향으로의 변환을 하게 된다. ArgumentResolver 글에서 설명한 내용을 잘 이해했으면 여기서 사용한 메소드를 이해하는데 큰 무리가 없으리라 본다


다른 메소드에 대한 설명은 생략하지만 VO 클래스 객체를 DataSet으로 변환할때 사용된 메소드인 skipDataSet 메소드에 대한 설명은 하고자 한다. model에서 Xplatform의 Variable 객체나 DataSet 객체로의 변환과는 무관한 클래스 객체들이 있다. 이러한 클래스가 있는지는 개발하는 과정에서 발생되는 예외를 보면 알게된다. 그래서 이런 상황일 경우 debug 모드로 프로젝트를 실행해서 파라미터도 넘겨받은 map에 어떤 클래스 객체들이 있는지 살펴봐서 해당 클래스를 알아내면 된다. 이런 클래스 객체인지 확인하기 위해 해당 객체를 파라미터로 넘겨서 변환에서 제외되어야 할 클래스이면 true, 그렇지 않으면 false를 return 하도록 했다. 지금은 이 skipDataSet 메소드에서 제외해야 할 클래스로 Spring에서 제공되는 BeanPropertyBindingResult 클래스와 RequestContext 클래스를 설정했으나 이것은 이 템플릿 상황에서 이 2개의 클래스가 불필요해서 넣은것이지 어떤 상황에서든 이 2개만 하면 되는건 아니다. 이러한 클래스는 비즈니스 로직 상황에서도 인위적으로 변환작업에 예외를 둘 수도 있다. 이것은 자신이 직접 작업해보면서 불필요한 클래스 객체가 발견되면 이 메소드에 해당 클래스를 추가해서 작업해주면 된다. 


이렇게 변환한 객체들을 VaribaleList 객체와 DataSetList 객체에 해당 변수들과 DataSet 들을 넣는 작업을 마치면 마지막으로 작업 결과 코드와 작업 결과 메시지를 넣어야 한다. 아래 코드를 보자


if(!model.containsKey("ErrorCode")) {
	variableList.add("ErrorCode", ERROR_CODE_VALUE);
}

if(!model.containsKey("ErrorMsg")) {
	variableList.add("ErrorMsg", ERROR_MSG_VALUE);
}


이 코드는 작업 결과 코드와 작업 결과 메시지를 넣는 코드이다. 파라미터로 받은 model에 ErrorCode란 key가 없을 경우(if문을 보면 조건에 !가 있다) VariableList 객체에 ErrorCode란 이름으로 XplatformView 클래스의 멤버변수로 설정한 ERROR_CODE_VALUE 값을 넣게 된다. 마찬가지로 model에 ErrorMsg란 key가 없을 경우 VariableList 객체에 ErrorMsg란 이름으로 XplatformView 클래스의 멤버변수로 설정한 ERROR_MSG_VALUE 값을 넣게 된다. 그러면 만약 model에 ErrorCode나 ErrorMsg란 key가 이미 있었다면 어떻게 됐었을까? 그랬다면 이 if문을 거치기 이전에 VariableList 객체에 Variable 객체를 만들어 넣는 과정에서 이미 해당 객체를 만들어서 VariableList 클래스 객체에 넣어 놓는 작업을 진행했을것이다. 여기서 작업결과 코드와 작업결과 메시지 넘겨줄때 반드시 ErrorCode와 ErrorMsg란 이름으로 넘겨줘야 한다. 예전 글에서도 한번 언급했지만 Xplatform에서 서버를 통해 작업결과와 메시지를 받을때는 ErrorCode 와 ErrorMsg란 이름으로 받아야하는 일종의 개발 규약이 있어서 그렇다.


지금까지 Xplatform Client로 출력하기 위해 사용되는 클래스인 XplatformViewResolver와 XplatformView 클래스에 대해 설명했다. 다음에는 여기서 잠깐 언급하게 되었던 ErrorCode와 ErrorMsg를 설정하게 되는 과정인 예외처리 부분에 대해 설명하도록 하겠다.


 1. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (1) - 개요

 2. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (2) - 사전지식

 3. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (3) - HttpServletRequestWrapper

 4. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (4) - Spring Controller에서 하려는 것

 5. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (5) - HandlerMethodArgumentResolver 분석(1)

 6. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (6) - HandlerMethodArgumentResolver 분석(2)

 7. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (7) - HandlerMethodArgumentResolver 분석(3)

 8. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (8) - HandlerMethodArgumentResolver 분석(4)

 9. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (9) - XplatformView 분석

 10. Xplatform과 Spring Framework 연동 템플릿으로 보는 HandlerMethodArgumentResolver와 ViewResolver (10) - 예외처리


트랙백을 확인할 수 있습니다

URL을 배껴둬서 트랙백을 보낼 수 있습니다

다른 카테고리의 글 목록

프로그래밍/Spring 카테고리의 포스트 목록을 보여줍니다