概要
Gateway、EurekaといったSpring Cloudを使ってマイクロサービスを構築する。ここではシングル構成での構成で実現する。
前提
以下のURLから雛形を作成してマイクロサービスを作成する。
シングル構築でのマイクロサービス構築
まずはシングル構成で動くことを確認する。
サーバは１台でその上に全てのマイクロサービスを実装する。ホスト名はlocalhostにした方が汎用的だが、将来クラスタ構成とするためホスト名であるms01を明示的に指定して構築する。
作成手順
最初にEurekaのマイクロサービスを作成し起動する。他のマイクロサービスはEurekaのクライアントとして動作するので、Eurekaサーバが動作している必要がある。Eurekaのクライアントが起動する際、クライアントの情報がEurekaサーバに登録される。
Eureka
Eurekaのコードはこんな感じ。
package comm.example.eurekaserver;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer; //追加
@EnableEurekaServer //追加
@SpringBootApplication
public class EurekaServerApplication {
public static void main(String[] args) {
SpringApplication.run(EurekaServerApplication.class, args);
}
}
spring:
cloud:
inetutils:
preferredNetworks:
- 10.10.10
server:
port: 8761
eureka:
instance:
hostname: ms01
client:
registerWithEureka: false
fetchRegistry: false
serviceUrl:
defaultZone: http://ms01:8761/eureka/
Service-1/Service-2の作成
続きてユーザアプリケーションとしてのマイクロサービス、Service-1/Service-2を作成する。
Service-1のソース
package com.example.app1service;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient; //追加
@SpringBootApplication
@EnableEurekaClient //追加
public class App1ServiceApplication {
public static void main(String[] args) {
SpringApplication.run(App1ServiceApplication.class, args);
}
}
package com.example.app1service.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class App1Controller {
@RequestMapping("/hello")
public String hello() {
return "Hello from Server-A";
}
}
spring:
application:
name: app1-service # Eurekaの管理画面で表示されるサービス名
server:
port: 8081
eureka:
client:
serviceUrl:
defaultZone: http://ms01:8761/eureka/
Service-2もほぼ同様の作り。
package com.example.app2service;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient; //追加
@SpringBootApplication
@EnableEurekaClient //追加
public class App2ServiceApplication {
public static void main(String[] args) {
SpringApplication.run(App2ServiceApplication.class, args);
}
}
package com.example.app2service.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class App2Controller {
@RequestMapping("/goodbye")
public String hello() {
return "GoodBye from EurekaClient App2";
}
}
spring:
application:
name: app2-service
server:
port: 8082
eureka:
client:
serviceUrl:
defaultZone: http://ms01:8761/eureka/
Gatewayの作成
Gatewayの作り方として、ルーティングをJavaで実装するパターンもあるようだが、ここではapplication.ymlファイルにルーティング情報を書くやり方で実現する。
package com.example.gateway;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
@SpringBootApplication
@EnableEurekaClient
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class, args);
}
}
server:
port: 8080
eureka:
client:
serviceUrl:
defaultZone: http://ms01:8761/eureka/
spring:
application:
name: gateway-service
cloud:
gateway:
routes:
- id: app1Module
# uri: http://ms01:8081/ #単体で動かす場合はURL直指定でもOK。ただしクラスタに対応できない。
uri: lb://APP1-SERVICE # application:name を指定する
predicates:
- Path=/hello/** # app1で利用できるURLを指定
- id: app2Module # app2についてもapp1と同様の設定を行う
uri: lb://APP2-SERVICE
predicates:
- Path=/goodbye/**
デプロイ・起動
起動方法は全てのマイクロサービスで同じ手順なので代表例としてEurekaの手順を示すが、他のマイクロサービスも同様に起動できる。
Eclipse等でソースコードを作成後Mavenでeureka-server-0.0.1-SNAPSHOT.jarというjarファイルを作成する。で作成したjarファイルをサーバに転送して起動する。
なお起動順序は最初に言っているよう、Service-1/2およびGatewayはEurekaのクライアントとなるので、サーバであるEurekaを最初に起動し、その後EurekaクライアントのService-1/2およびGatewayを起動すること。
この例ではベタで起動しているが、systemctlで起動できるようサービス化してもいい。
[root@ms01 ~]# java -jar eureka-server-0.0.1-SNAPSHOT.jar
全てのマイクロサービスが起動したら、Eurekaの管理コンソール（っていうの？）には各マイクロサービスがEurekaのクライアントとして登録されている。
単体で動くかチェックする
Service-1およびService-2については単独でも動作する。
ブラウザから下記URLを叩いて、正常に応答が帰ってくるようならSerivce-1/2は正しく動いている。
http://ms01:8081/hello
http://ms01:8082/goodbye
Gatewayを経由して動くかチェックする
Gatewayは8080ポートで待ち受けていて、'/hello'がService-1の/helloに、goodbyeがService-2の/goodbyeに振り分けられる。
http://ms01:8080/hello
http://ms01:8080/goodbye
ここまで動作すると、シングル構成でGatewayを経由して各マイクロサービスにルーティングできるようになる。
ユーザとしては、それぞれのマイクロサービスが異なるサーバで動作していても、サーバが複数あることを気にすることなくGatewayのURLとマイクロサービスのパスを知っているとサービスにアクセス可能となる。
ただし、この構成はシングル構成のため、例えばService-1が落ちた場合、サービスの提供ができなくなる。
それだと困る場合は、こちらの多重構成での構築を参照して多重構成にする必要がある。