마이크로서비스 스튜디오 활용 가이드

본 가이드는 PaaS-TA와 마이크로서비스 스튜디오를 활용한 마이크로서비스 애플리케이션 개발 방법을 소개하는 가이드 문서이다. 개발에 대한 기초를 이해하고 있다면 더 많은 도움이 될 것이다. 가이드 구성은 다음과 같다.

가이드 구성

• 공동 주택 공시가격 애플리케이션 개요
  • 마이크로서비스 아키텍처 개념을 적용한 공동줕개 공시가격 애플리케이션 개발
  • 마이크로서비스 애플리케이션 분할 방법 소개
  • API 설계 방법
  • 공공데이터 포털 및 국토부에서 제공하는 OPEN API 활용 - [오픈데이터 API 활용 가이드 참조]
• JAVA 환경 구성 및 필수 체크 항목
  • 개발된 소스코드를 활용한 방법 소개
  • eclipse 활용적용
  • PaaS-TA 및 마이크로서비스 스튜디오 활용 시 반드시 적용해야 할 필수 체크 항목 설명
• PaaS-TA 활용 방법
  • 개발 소스코드를 이용한 PaaS-TA 환경 설정
  • PaaS-TA를 통한 애플리케이션 푸시 방법
  • 마이크로서비스 스튜디오 활용을 위한 환경 설정 방법
  • PaaS-TA 상에서 애플리케이션 실행 방법

공동주택 공시가격 애플리케이션

기본 기능

상세 기능 설명

1) 위치 검색 : 현재 위치에서 빠른 이동을 위한 단어 검색(건물, 주소 및 도로 등)

2) 영역 선택 : 지도상에서 시작점, 끝점 지정하고 범위 표시하기, 현재 위치로 이동하기

3) 공동주택 목록 : 지정 범위내에 공동 주택 목록 조회

4) 평당 공시가격 조회 : 선택한 공동 주택이 공시가격 조회

마이크로서비스 아키텍처 애플리케이션 분할 방법

지도상에서 선택한 영역(범위)내에 포함된 공동주택 평당 공시가격을 제공하기 위한 최소 기능단위별로 분할을 먼저 진행해본다. 마이크로서비스 아키텍처 기반 개발은 아주 작은 단위로 분할하여 다른 서비스에 전혀 영향을 받지 않도록 개발하는 방법으로 데이터 종속성이 배제되어야 하고 여러개의 서비스를 포함하고 있으면 기준에 맞지 않는다. 분할 기준의 정확한 답은 없지만 데이터가 다른 서비스의 데이터와 종속되면 안된다.

아래 그림과 같은 기준으로 분할될 수 있다. 하지만 너무 작게 분할되었을 경우의 퍼포먼스를 고려하여 동일 데이터를 사용하는 서비스는 하나로 묶어도 무방한다.

서비스 단위 분할	데이터 종속에 따른 분할
	하나의 기능을 구현하는데 여러 개의 서비스를 조합하여 기능을 제공함.

마이크로서비스 아키텍처 애플리케이션 설계

서비스 정의

마이크로서비스 단위의 분할이 확정되면, 서비스와 서비스간의 통신 방법(규약)을 정하고 FRONTEND와 BACKEND로 구분한다. 서비스간의 통신 규약은 여러가지가 있으나 여기에서는 REST API 방식을 사용한다.

최종으로 확정된 마이크로서비스 구성은 아래 그림과 같다.

API 설계

1) 두점을 이용한 PNU 조회 API

2) PNU에 따른 공동주택 정보 조회 API

3) PNU에 따른 평방미터 공시가격 조회 API

API 호출 방법

BACKEND에 정의한 API를 FRONTEND에서 호출하여 결과값을 보여준다.

• API 예시

  @GetMapping(“/api/search/all")
  ~
  …..
  URI uri = URI.create("http://apigateway/backend/api/search/all");
  ~
  @GetMapping(“/api/facilities/list")
  ~
  ….
  URI uri = URI.create(" http://apigateway/backend/api/facilities/list ");
  

마이크로서비스 아키텍처 기반 애플리케이션 구성

마이크로서비스 아키텍처 기반 애플리케이션 개발은 단일 서비스로 개발하고 REST API를 이용하여 다른 서비스를 호출하는 방식으로 아주 많은 서비스와 통신할 수 있다. 프론트엔드는 모바일, 웹과 같이 하나의 앱으로 개발하고 백엔드 영역은 서비스 단위로 분할하여 서비스를 제공하도록 개발해야 한다. 마이크로서비스 아키텍처의 장점인 폴리그랏을 적용하는 경우 여러 언어로 각각 개발했더라고 각 서비스 호출 시 사용하는 규약을 정하게 되면 얼마든지 확장이 가능하다.

마이크로서비스 아키텍처 개발을 위해 애플리케이션을 분할과 더불어 여러 서비스로 구성되어 있기 때문에 Service Discovery와 Gateway(네트워크) 정보를 관리할 수 있는 서버도 구성해야 한다. 개별적으로 이를 구성하려면 Spring Cloud와 같은 프레임워크를 구성하거나 유사한 프레임워크와 아키텍처를 구성해야 하지만, 마이크로서비스 스튜디오를 사용하면 필요한 모든 서비스를 제공하고 있어 개발에만 집중할 수 있다.

• 참고사항 : 클라우드 기반 개발지원 플랫폼은 현재는 자바 언어만 제공하고 있다.

마이크로서비스 개발 가이드

개발 준비

eclipse 또는 IntelliJ와 같은 IDE 환경을 구성한다. 기본 준비사항은 아래와 같다.

• 사용자 준비 사항

• 개발지원 플랫폼 지원 사항
  • MSXpert(마이크로서비스 스튜디오)와 PaaS(Cloud Foundry 4.0 또는 PaaS-TA 3.5)는 '클라우드 기반 개발지원 플랫폼에서 제공함'

PaaS-TA 활용 시

여기에서는 PaaS-TA를 활용하여 개발된 애플리케이션을 클라우드 상에 배포하는 경우를 가정하고 설명한다. 현재는 '클라우드혁신센터' 에서 운영하는 PaaS-TA 서버를 활용할 수 있다.

PaaS-TA를 활용하려면 접속 계정이 있어야 한다. 접속 계정이 없다면, cloud4de.kr 홈페이지에 접속하여 공지사항에 안내된 PaaS-TA 계정 신청하기를 이용한다.

아래 링크 이동 시 PaaS-TA 활용 방법이 소개되어 있으니 참고바랍니다.

파스타 활용 방법

Github 소스 코드 이용

마이크로서비스 애플리케이션 개발 시 활용 가능한 샘플 애플리케이션을 Github을 통해 공개하고 있다. 애플리케이션은 프론트엔드와 백엔드로 분류하여 폴더로 구성되어 있다.

• Github 주소 : https://github.com/startupcloudplatform

• Repository 구성

  • Open-Data-API : 오픈데이터API 사용자 및 제공처 포털 소스
  • Microservices : 마이크로서비스 스튜디오
  • Big-Data-Service-Borker : 빅데이터 서비스 브로커(PaaS-TA 3.0 버전용)
  • Sample-App-Tutorial
  • 그밖에 마이크로서비스로 개발된 API 6종

• 본 가이드에서는 공동주택 공시가격 제공 API 개발 소스코드 활용을 위해 Repository 에서 public-land-value 저장소를 로컬에 클론으로 다운받는다.

  • git clone : git clone https://github.com/startupcloudplatform/public-land-value.git

  • 윈도우 PowerShell - C:>git clone https://github.com/startupcloudplatform/public-land-value.git

  • 현재 경로에 Git Repository 경로와 동일한 경로가 생성된다.

    

프로젝트 환경 설정

본 개발 가이드는 eclipse 를 이용한 화면으로 설명한다. 익숙한 어떤 IDE를 사용해도 무방하고 여기에서 가이드하는 환경설정에 필요한 프레임워크 및 기타 설정은 반드시 적용한다.

git clone을 통해 경로를 로컬에 생성했기 때문에 eclipse을 통해서 바로 기존 파일 시스템을 로드할 수 있다. 개발에 익숙한 경우는 새로 생성해도 된다.

1) 기존 프로젝트 폴더를 로드하면 소스 구조가 보일 것이다.

2) PaaS-TA와 마이크로서비스 스튜디오를 활용해서 개발 시 필수로 체크하는 파일은 아래와 같다.

※ JAVA 개발 가이드는 마이크로서비스 스튜디오 메인 메뉴 > DOCS 메뉴를 참고한다.

• 마이크로서비스 스튜디오 > DOCS

• pom.xml

• annotation 정의
• application.properties
• bootstrap.properties
• manifest.yml

JAVA 필수 체크 항목

• pom.xml

  생성한 프로젝트에 pom.xml 에 JAVA 버전 및 프레임워크 등 정의할 내용을 반드시 정의한다.

  JAVA : 1.8이상, Spring Boot: 1.5.13, Spring Cloud: Edgware.RELEASE

  <parent>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-parent</artifactId>
          <version>1.5.13.RELEASE</version>
          <relativePath/> <!-- lookup parent from repository -->
     </parent>
  
     <properties>
          <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
          <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
          <java.version>1.8</java.version>
          <spring-cloud.version>Edgware.RELEASE</spring-cloud.version>
     </properties>
  

  

• annotation 정의

  마이크로서비스 스튜디오를 활용한 애플리케이션 개발은 필수 annonation이 정의되어야 한다. 필수 annotation 은 다음과 같다.

  package com.crossent.microservice;
  
  import org.springframework.boot.SpringApplication;
  import org.springframework.boot.autoconfigure.SpringBootApplication;
  import org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker;
  import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Configuration;
  import springfox.documentation.builders.PathSelectors;
  import springfox.documentation.builders.RequestHandlerSelectors;
  import springfox.documentation.spi.DocumentationType;
  import springfox.documentation.spring.web.plugins.Docket;
  import springfox.documentation.swagger2.annotations.EnableSwagger2;
  
  @EnableDiscoveryClient
  @EnableCircuitBreaker
  @SpringBootApplication
  public class FrontApplication {
  
      public static void main(String[] args) {
          SpringApplication.run(FrontApplication.class, args);
      }
  
  }
  
  @Configuration
  @EnableSwagger2
  class SwaggerConfig {
      @Bean
      public Docket api() {
          return new Docket(DocumentationType.SWAGGER_2)
                  .select().apis(RequestHandlerSelectors.any())
                  .paths(PathSelectors.ant("/api/**"))
                  .build();
      }
  }
  

  

• properties 정의

  java의 properties는 애플리케이션의 구성 가능한 파라미터들을 저장하기 위해 자바 관련 기술을 사용하는 파일들을 위한 파일 확장자로 마이크로서비스 애플리케이션 개발을 위해 두개의 properties 파일을 사용한다.

  • application.properties

  server.port: ${PORT:8081}
  eureka.instance.hostname=${CF_INSTANCE_INTERNAL_IP:localhost}
  eureka.instance.nonSecurePort=${PORT:8091}
  

  

• bootstrap.properties

  spring.application.name=영문앱이름
  

  

마이크로서비스 스튜디오를 활용한 개발을 위한 필수 항목은 모두 정의가 완료되었다. 그 밖에 코드는 자신의 코드로 정의하면 된다.

manifest 정의

paas-ta을 통해 앱을 푸시하려면 manifest.yml파일을 정의해야 한다. github에서 다운받은 소스폴더 안에 manifest.yml 파일이 있다. 이 파일에서 마이크로서비스 애플리케이션을 위한 사용자 환경 변수를 정의해야 한다.

---
applications:
  - name: plv-back
    memory: 1G
    path: target/plv-back-0.0.1-SNAPSHOT.jar
    env:
      msa: yes
      private:

cf orgs
cf create-org { 조직명 }
cf create-space -o { 조직명 } { 영역명 }
cf target -o { 조직명 }  -s { 영역명 }

---
applications:
  - name: plv-back
    memory: 1G
    path: target/plv-back-0.0.1-SNAPSHOT.jar
    env:
      msa: yes
      private:

cf push

cf env public-back

cf apps