|
目录
- 背景
- 为什么要用Istio?
- 编写部署文件
- 部署应用到 Istio
背景
大家好,搞微服务也有好几年时间,从 16 年开始就一直关注微服务,到现在一直在使用的还是 SpringCloud 原生那套。
虽然后来出现了 SpringCloud Alibaba,但由于前面的所有系统框架都已定,就没有在变化。
而在微服务的实施过程,为了降运维的服务度,先后使用了 jenkins,docker, kubernetes 等,就还是没有使用过 Istio。基于这个原因,一直想尝试下开发基于 Istio的 ServiceMesh 的应用。
正好最近受够了 SpringCloud 的“折磨”,对 Kubernetes 也可以熟练使用了,而且网上几乎没有 SpringBoot 微服务部署到 Istio 的案例,我就开始考虑用 SpringBoot 写个微服务的 Demo 并且部署到 Istio。
项目本身不复杂,就是发送一个字符串并且返回一个字符串的最简单的 Demo。
为什么要用 Istio?
目前,对于 Java 技术栈来说,构建微服务的最佳选择是 SpringBoot 而 SpringBoot 一般搭配目前落地案例很多的微服务框架 SpringCloud 来使用。
SpringCloud 看似很完美,但是在实际上手开发后,很容易就会发现 SpringCloud 存在以下比较严重的问题。
例如:
- 服务治理相关的逻辑存在于 SpringCloud Netflix 等 SDK 中,与业务代码紧密耦合。
- SDK 对业务代码侵入太大,SDK 发生升级且无法向下兼容时,业务代码必须做出改变以适配 SDK 的升级——即使业务逻辑并没有发生任何变化。
- 各种组件令人眼花缭乱,质量也参差不齐,学习成本太高,且组件之间代码很难完全复用,仅仅为了实现治理逻辑而学习 SDK 也并不是很好的选择。
- 绑定于 Java 技术栈,虽然可以接入其他语言但要手动实现服务治理相关的逻辑,不符合微服务“可以用多种语言进行开发”的原则。
- SpringCloud 仅仅是一个开发框架,没有实现微服务所必须的服务调度、资源分配等功能,这些需求要借助 Kubernetes 等平台来完成。但 SpringCloud 与 Kubernetes 功能上有重合,且部分功能也存在冲突,二者很难完美配合。
替代 SpringCloud 的选择有没有呢?有!它就是 Istio。
Istio 彻底把治理逻辑从业务代码中剥离出来,成为了独立的进程(Sidecar)。部署时两者部署在一起,在一个 Pod 里共同运行,业务代码完全感知不到 Sidecar 的存在。
这就实现了治理逻辑对业务代码的零侵入——实际上不仅是代码没有侵入,在运行时两者也没有任何的耦合。
这使得不同的微服务完全可以使用不同语言、不同技术栈来开发,也不用担心服务治理问题,可以说这是一种很优雅的解决方案了。
所以,“为什么要使用 Istio”这个问题也就迎刃而解了——因为 Istio 解决了传统微服务诸如业务逻辑与服务治理逻辑耦合、不能很好地实现跨语言等痛点,而且非常容易使用。只要会用 Kubernetes,学习 Istio 的使用一点都不困难。
为什么要使用 gRPC 作为通信框架?
在微服务架构中,服务之间的通信是一个比较大的问题,一般采用 RPC 或者 RESTful API 来实现。
SpringBoot 可以使用 RestTemplate 调用远程服务,但这种方式不直观,代码也比较复杂,进行跨语言通信也是个比较大的问题。
而 gRPC 相比 Dubbo 等常见的 Java RPC 框架更加轻量,使用起来也很方便,代码可读性高,并且与Istio 和Kubernetes 可以很好地进行整合,在 Protobuf 和 HTTP2 的加持下性能也还不错。
所以这次选择了 gRPC来解决 SpringBoot微服务间通信的问题。并且,虽然 gRPC 没有服务发现、负载均衡等能力,但是 Istio 在这方面就非常强大,两者形成了完美的互补关系。
由于考虑到各种 grpc-spring-boot-starter 可能会对 SpringBoot 与 Istio 的整合产生不可知的副作用。
所以这一次我没有用任何的 grpc-spring-boot-starter,而是直接手写了 gRPC 与 SpringBoot 的整合。
编写业务代码
首先使用 Spring Initializr 建立父级项目 spring-boot-istio,并引入 gRPC 的依赖。
pom 文件如下:
<?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?>
<project xmlns=&#34;http://maven.apache.org/POM/4.0.0&#34;
xmlns:xsi=&#34;http://www.w3.org/2001/XMLSchema-instance&#34;
xsi:schemaLocation=&#34;http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd&#34;>
<modelVersion>4.0.0</modelVersion>
<modules>
<module>spring-boot-istio-api</module>
<module>spring-boot-istio-server</module>
<module>spring-boot-istio-client</module>
</modules>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.6.RELEASE</version>
<relativePath/>
</parent>
<groupId>site.wendev</groupId>
<artifactId>spring-boot-istio</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>spring-boot-istio</name>
<description>Demo project for Spring Boot With Istio.</description>
<packaging>pom</packaging>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>io.grpc</groupId>
<artifactId>grpc-all</artifactId>
<version>1.28.1</version>
</dependency>
</dependencies>
</dependencyManagement>
</project>然后建立公共依赖模块 spring-boot-istio-api,pom 文件如下,主要就是 gRPC 的一些依赖:
<?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?>
<project xmlns=&#34;http://maven.apache.org/POM/4.0.0&#34;
xmlns:xsi=&#34;http://www.w3.org/2001/XMLSchema-instance&#34;
xsi:schemaLocation=&#34;http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd&#34;>
<parent>
<artifactId>spring-boot-istio</artifactId>
<groupId>site.wendev</groupId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>spring-boot-istio-api</artifactId>
<dependencies>
<dependency>
<groupId>io.grpc</groupId>
<artifactId>grpc-all</artifactId>
</dependency>
<dependency>
<groupId>javax.annotation</groupId>
<artifactId>javax.annotation-api</artifactId>
<version>1.3.2</version>
</dependency>
</dependencies>
<build>
<extensions>
<extension>
<groupId>kr.motd.maven</groupId>
<artifactId>os-maven-plugin</artifactId>
<version>1.6.2</version>
</extension>
</extensions>
<plugins>
<plugin>
<groupId>org.xolstice.maven.plugins</groupId>
<artifactId>protobuf-maven-plugin</artifactId>
<version>0.6.1</version>
<configuration>
<protocArtifact>com.google.protobuf:protoc:3.11.3:exe:${os.detected.classifier}</protocArtifact>
<pluginId>grpc-java</pluginId>
<pluginArtifact>io.grpc:protoc-gen-grpc-java:1.28.1:exe:${os.detected.classifier}</pluginArtifact>
<protocExecutable>/Users/cloudnativehome/tools/protoc-3.11.3/bin/protoc</protocExecutable>
</configuration>
<executions>
<execution>
<goals>
<goal>compile</goal>
<goal>compile-custom</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>建立 src/main/proto 文件夹,在此文件夹下建立 hello.proto,定义服务间的接口如下:
syntax = &#34;proto3&#34;;
option java_package = &#34;site.wendev.spring.boot.istio.api&#34;;
option java_outer_classname = &#34;HelloWorldService&#34;;
package helloworld;
service HelloWorld {
rpc SayHello (HelloRequest)
returns (HelloResponse) {}
}
message HelloRequest {
string name = 1;
}
message HelloResponse {
string message = 1;
}很简单,就是发送一个 name 返回一个带 name 的 message。然后生成服务端和客户端的代码,并且放到 java 文件夹下。这部分内容可以参考 gRPC 的官方文档。
有了 API 模块之后,就可以编写服务提供者(服务端)和服务消费者(客户端)了。这里我们重点看一下如何整合 gRPC 和 SpringBoot。
①服务端
业务代码非常简单:
@Slf4j
@Component
public class HelloServiceImpl extends HelloWorldGrpc.HelloWorldImplBase {
@Override
public void sayHello(HelloWorldService.HelloRequest request,
StreamObserver<HelloWorldService.HelloResponse> responseObserver) {
// 根据请求对象建立响应对象,返回响应信息
HelloWorldService.HelloResponse response = HelloWorldService.HelloResponse
.newBuilder()
.setMessage(String.format(&#34;Hello, %s. This message comes from gRPC.&#34;, request.getName()))
.build();
responseObserver.onNext(response);
responseObserver.onCompleted();
log.info(&#34;Client Message Received:[{}]&#34;, request.getName());
}
}光有业务代码还不行,我们还需要在应用启动时把 gRPC Server 也给一起启动起来。首先写一下 Server 端的启动、关闭等逻辑:
@Slf4j
@Componentpublic class GrpcServerConfiguration {
@Autowired
HelloServiceImpl service;
/** 注入配置文件中的端口信息 */
@Value(&#34;${grpc.server-port}&#34;)
private int port;
private Server server;
public void start() throws IOException {
// 构建服务端
log.info(&#34;Starting gRPC on port {}.&#34;, port);
server = ServerBuilder.forPort(port).addService(service).build().start();
log.info(&#34;gRPC server started, listening on {}.&#34;, port);
// 添加服务端关闭的逻辑
Runtime.getRuntime().addShutdownHook(new Thread(() -> {
log.info(&#34;Shutting down gRPC server.&#34;);
GrpcServerConfiguration.this.stop();
log.info(&#34;gRPC server shut down successfully.&#34;);
}));
}
private void stop() {
if (server != null) {
// 关闭服务端
server.shutdown();
}
}
public void block() throws InterruptedException {
if (server != null) {
// 服务端启动后直到应用关闭都处于阻塞状态,方便接收请求
server.awaitTermination();
}
}
}定义好 gRPC 的启动、停止等逻辑后,就可以使用 CommandLineRunner 把它加入到 SpringBoot 的启动中去了:
@Component
public class GrpcCommandLineRunner implements CommandLineRunner {
@Autowired
GrpcServerConfiguration configuration;
@Override
public void run(String... args) throws Exception {
configuration.start();
configuration.block();
}
}之所以要把 gRPC 的逻辑注册成 Spring Bean,就是因为在这里要获取到它的实例并进行相应的操作。
这样,在启动 SpringBoot 时,由于 CommandLineRunner 的存在,gRPC 服务端也就可以一同启动了。
②客户端
业务代码同样非常简单:
@RestController
@Slf4j
public class HelloController {
@Autowired
GrpcClientConfiguration configuration;
@GetMapping(&#34;/hello&#34;)
public String hello(@RequestParam(name = &#34;name&#34;, defaultValue = &#34;云原生之家&#34;, required = false) String name) {
// 构建一个请求 HelloWorldService.HelloRequest request = HelloWorldService.HelloRequest
.newBuilder()
.setName(name)
.build(); // 使用stub发送请求至服务端
HelloWorldService.HelloResponse response = configuration.getStub().sayHello(request);
log.info(&#34;Server response received: [{}]&#34;, response.getMessage());
return response.getMessage();
}
}在启动客户端时,我们需要打开 gRPC 的客户端,并获取到 channel 和 stub 以进行 RPC 通信。
来看看 gRPC 客户端的实现逻辑:
@Slf4j
@Component
public class GrpcClientConfiguration {
/** gRPC Server的地址 */
@Value(&#34;${server-host}&#34;)
private String host;
/** gRPC Server的端口 */
@Value(&#34;${server-port}&#34;)
private int port;
private ManagedChannel channel;
private HelloWorldGrpc.HelloWorldBlockingStub stub;
public void start() {
// 开启channel
channel = ManagedChannelBuilder.forAddress(host, port).usePlaintext().build();
// 通过channel获取到服务端的stub
stub = HelloWorldGrpc.newBlockingStub(channel);
log.info(&#34;gRPC client started, server address: {}:{}&#34;, host, port);
}
public void shutdown() throws InterruptedException {
// 调用shutdown方法后等待1秒关闭channel
channel.shutdown().awaitTermination(1, TimeUnit.SECONDS);
log.info(&#34;gRPC client shut down successfully.&#34;);
}
public HelloWorldGrpc.HelloWorldBlockingStub getStub() {
return this.stub;
}
}比服务端要简单一些。最后,仍然需要一个 CommandLineRunner 把这些启动逻辑加入到 SpringBoot 的启动过程中:
@Component
@Slf4j
public class GrpcClientCommandLineRunner implements CommandLineRunner {
@Autowired
GrpcClientConfiguration configuration;
@Override
public void run(String... args) {
// 开启gRPC客户端
configuration.start();
// 添加客户端关闭的逻辑
Runtime.getRuntime().addShutdownHook(new Thread(() -> {
try {
configuration.shutdown();
} catch (InterruptedException e) {
e.printStackTrace();
}
}));
}
}编写 Dockerfile
业务代码跑通之后,就可以制作 Docker 镜像,准备部署到 Istio 中去了。
在开始编写 Dockerfile 之前,先改动一下客户端的配置文件:
server:
port: 19090
spring:
application:
name: spring-boot-istio-clientserver-host: ${server-host}server-port: ${server-port}接下来编写 Dockerfile。
①服务端:
FROM openjdk:8u121-jdk
RUN /bin/cp /usr/share/zoneinfo/Asia/Shanghai /etc/localtime \
&& echo &#39;Asia/Shanghai&#39; >/etc/timezone
ADD /target/spring-boot-istio-server-0.0.1-SNAPSHOT.jar /ENV
SERVER_PORT=&#34;18080&#34; ENTRYPOINT java -jar /spring-boot-istio-server-0.0.1-SNAPSHOT.jar主要是规定服务端应用的端口为 18080,并且在容器启动时让服务端也一起启动。
②客户端:
FROM openjdk:8u121-jdk
RUN /bin/cp /usr/share/zoneinfo/Asia/Shanghai /etc/localtime \
&& echo &#39;Asia/Shanghai&#39; >/etc/timezoneADD /target/spring-boot-istio-client-0.0.1-SNAPSHOT.jar /ENV GRPC_SERVER_HOST=&#34;spring-boot-istio-server&#34;ENV GRPC_SERVER_PORT=&#34;18888&#34;ENTRYPOINT java -jar /spring-boot-istio-client-0.0.1-SNAPSHOT.jar \ --server-host=$GRPC_SERVER_HOST \ --server-port=$GRPC_SERVER_PORT可以看到这里添加了启动参数,配合前面的配置,当这个镜像部署到 Kubernetes 集群时,就可以在 Kubernetes 的配合之下通过服务名找到服务端了。
同时,服务端和客户端的 pom 文件中添加:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<executable>true</executable>
</configuration>
</plugin>
<plugin>
<groupId>com.spotify</groupId>
<artifactId>dockerfile-maven-plugin</artifactId>
<version>1.4.13</version>
<dependencies>
<dependency>
<groupId>javax.activation</groupId>
<artifactId>activation</artifactId>
<version>1.1</version>
</dependency>
</dependencies>
<executions>
<execution>
<id>default</id>
<goals>
<goal>build</goal>
<goal>push</goal>
</goals>
</execution>
</executions>
<configuration>
<repository>wendev-docker.pkg.coding.net/develop/docker/${project.artifactId}</repository>
<tag>${project.version}</tag>
<buildArgs>
<JAR_FILE>${project.build.finalName}.jar</JAR_FILE>
</buildArgs>
</configuration>
</plugin>
</plugins>
</build>这样执行 mvn clean package 时就可以同时把 docker 镜像构建出来了。
编写部署文件
有了镜像之后,就可以写部署文件了。
①服务端:
apiVersion: v1
kind: Service
metadata:
name: spring-boot-istio-server
spec:
type: ClusterIP
ports:
- name: http
port: 18080
targetPort: 18080
- name: grpc
port: 18888
targetPort: 18888
selector:
app: spring-boot-istio-server
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: spring-boot-istio-server
spec:
replicas: 1
selector:
matchLabels:
app: spring-boot-istio-server
template:
metadata:
labels:
app: spring-boot-istio-server
spec:
containers:
- name: spring-boot-istio-server
image: wendev-docker.pkg.coding.net/develop/docker/spring-boot-istio-server:0.0.1-SNAPSHOT
imagePullPolicy: Always
tty: true
ports:
- name: http
protocol: TCP
containerPort: 18080
- name: grpc
protocol: TCP
containerPort: 18888主要是暴露服务端的端口:18080 和 gRPC Server 的端口 18888,以便可以从 Pod 外部访问服务端。
②客户端:
apiVersion: v1
kind: Service
metadata:
name: spring-boot-istio-client
spec:
type: ClusterIP
ports:
- name: http
port: 19090
targetPort: 19090
selector:
app: spring-boot-istio-client
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: spring-boot-istio-client
spec:
replicas: 1
selector:
matchLabels:
app: spring-boot-istio-client
template:
metadata:
labels:
app: spring-boot-istio-client
spec:
containers:
- name: spring-boot-istio-client
image: wendev-docker.pkg.coding.net/develop/docker/spring-boot-istio-client:0.0.1-SNAPSHOT
imagePullPolicy: Always
tty: true
ports:
- name: http
protocol: TCP
containerPort: 19090主要是暴露客户端的端口 19090,以便访问客户端并调用服务端。
如果想先试试把它们部署到 k8s 可不可以正常访问,可以这样配置 Ingress:
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
name: nginx-web
annotations:
kubernetes.io/ingress.class: &#34;nginx&#34;
nginx.ingress.kubernetes.io/use-reges: &#34;true&#34;
nginx.ingress.kubernetes.io/proxy-connect-timeout: &#34;600&#34;
nginx.ingress.kubernetes.io/proxy-send-timeout: &#34;600&#34;
nginx.ingress.kubernetes.io/proxy-read-timeout: &#34;600&#34;
nginx.ingress.kubernetes.io/proxy-body-size: &#34;10m&#34;
nginx.ingress.kubernetes.io/rewrite-target: /
spec:
rules:
- host: dev.wendev.site
http:
paths:
- path: /
backend:
serviceName: spring-boot-istio-client
servicePort: 19090Istio 的网关配置文件与 k8s 不大一样:
apiVersion: networking.istio.io/v1alpha3
kind: Gateway
metadata:
name: spring-boot-istio-gateway
spec:
selector:
istio: ingressgateway
servers:
- port:
number: 80
name: http
protocol: HTTP
hosts:
- &#34;*&#34;
---
apiVersion: networking.istio.io/v1alpha3
kind: VirtualService
metadata:
name: spring-boot-istio
spec:
hosts:
- &#34;*&#34;
gateways:
- spring-boot-istio-gateway
http:
- match:
- uri:
exact: /hello
route:
- destination:
host: spring-boot-istio-client
port:
number: 19090主要就是暴露/hello 这个路径,并且指定对应的服务和端口。
部署应用到 Istio
首先搭建 k8s 集群并且安装 istio,使用 istioctl 命令安装 Istio。建议跑通官方的 bookinfo 示例之后再来部署本项目。
注:以下命令都是在开启了自动注入 Sidecar 的前提下运行的。
我是在虚拟机中运行的 k8s,所以istio-ingressgateway 没有外部 IP:
$ kubectl get svc istio-ingressgateway -n istio-system
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S)
AGEistio-ingressgateway NodePort 10.97.158.232 <none> 15020:30388/TCP,80:31690/TCP,443:31493/TCP,15029:32182/TCP,15030:31724/TCP,15031:30887/TCP,15032:30369/TCP,31400:31122/TCP,15443:31545/TCP 26h所以,需要设置 IP 和端口,以 NodePort 的方式访问 gateway:
export INGRESS_PORT=$(kubectl -n istio-system get service istio-ingressgateway -o jsonpath=&#39;{.spec.ports[?(@.name==&#34;http2&#34;)].nodePort}&#39;)
export SECURE_INGRESS_PORT=$(kubectl -n istio-system get service istio-ingressgateway -o jsonpath=&#39;{.spec.ports[?(@.name==&#34;https&#34;)].nodePort}&#39;)
export INGRESS_HOST=127.0.0.1export GATEWAY_URL=$INGRESS_HOST:$INGRESS_PORT这样就可以了。
接下来部署服务:
$ kubectl apply -f spring-boot-istio-server.yml
$ kubectl apply -f spring-boot-istio-client.yml
$ kubectl apply -f istio-gateway.yml必须要等到两个 pod 全部变为 Running 而且 Ready 变为 2/2(两个容器都已ready) 才算部署完成。
接下来就可以通过:
curl -s http://${GATEWAY_URL}/hello访问到服务了。如果成功返回了 Hello, 云原生之家. This message comes from gRPC.的结果,没有出错则说明部署完成。 |
|