SpringBoot应用接入

功能简介

Spring Boot是一个构建在Spring框架顶部的项目。它提供了一种简便，快捷的方式来设置，配置和运行基于Web的简单应用程序，为了方便 Spring Boot 用户快速接入北极星，我们通过以下几个示例帮助用户如何在 Spring Boot 中体验北极星的相关功能。

快速入门

前提条件

您需要先下载 Polaris Server，具体操作参见 Polaris 服务端安装

确定 Spring Boot 版本

确认自己项目的 Spring Boot 版本
  1. ➜  mvn dependency:tree  | grep "org.springframework.boot:spring-boot-starter:jar"
  2. [INFO] |  +- org.springframework.boot:spring-boot-starter:jar:2.6.9:compile

根据命令查询到的 spring boot 版本信息，我们在根据下面的版本列表对应关系选择合适的 Spring Boot 以及 Spring Boot Polaris 版本

版本列表

这里列出了不同 Spring Boot 版本相对应的 Spring Boot Polaris 版本。 您需要先查看您当前使用的 Spring Boot 版本，从而确定需要引入的 Spring Boot Polaris 版本。

Spring Boot 兼容版本Spring Boot Polaris 版本
2.4.x1.1.0

接下来所有的示例我们将基于 Spring Boot 版本为 2.4.3、Spring Boot Polaris 版本为 1.1.0 开展。

服务注册

初始化项目

使用 jetbrain idea 等工具初始化一个 maven 项目

引入依赖

在上一步初始化好一个 maven 项目之后，我们在 pom.xml 中引入 Spring Boot Polaris 相关依赖。

  • 引入 spring-boot-polaris-dependencies 进行管理 Spring Boot Polaris 相关组件的依赖版本。
  • 引入 spring-boot-polaris-discovery-starter 实现 Spring Boot 服务注册到北极星中。
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  6.     <parent>
  7.         <groupId>org.springframework.boot</groupId>
  8.         <artifactId>spring-boot-starter-parent</artifactId>
  9.         <version>2.4.3</version>
  10.         <relativePath/> <!-- lookup parent from repository -->
  11.     </parent>
  12.     ...
  14.     <dependencyManagement>
  15.         <dependencies>
  16.             <dependency>
  17.                 <groupId>com.tencent.polaris</groupId>
  18.                 <artifactId>spring-boot-polaris-dependencies</artifactId>
  19.                 <version>1.1.0</version>
  20.                 <type>pom</type>
  21.                 <scope>import</scope>
  22.             </dependency>
  23.         </dependencies>
  24.     </dependencyManagement>
  26.     <dependencies>
  27.         <dependency>
  28.             <groupId>org.springframework.boot</groupId>
  29.             <artifactId>spring-boot-starter-web</artifactId>
  30.         </dependency>
  32.         <!-- 引入 Spring Boot Polaris Discovery 依赖用于实现服务注册 -->
  33.         <dependency>
  34.             <groupId>com.tencent.polaris</groupId>
  35.             <artifactId>spring-boot-polaris-discovery-starter</artifactId>
  36.         </dependency>
  37.     </dependencies>
  38.     ...
  39. </project>
配置 application.properties

在 resources 目录下创建 application.properties 文件，并按照如下进行配置

  1. .
  2. ├── java
  3. │   └── com
  4. │       └── example
  5. │           └── springbootpolarisprovider
  6. │               └── SpringbootProviderApplication.java
  7. └── resources
  8.     └── application.properties
  1. server.port=28888
  2. spring.application.name=BootEchoServer
  3. polaris.address=grpc://127.0.0.1:8091
  4. polaris.discovery.register.enable=true
实例代码
  1. ```java
  2. @SpringBootApplication
  3. public class SpringbootProviderApplication {
  5.     public static void main(String[] args) {
  6.         SpringApplication.run(SpringbootProviderApplication.class, args);
  7.     }
  9.     @RestController
  10.     static class EchoController {
  12.         private final PolarisDiscoveryProperties properties;
  14.         EchoController(PolarisDiscoveryProperties properties) {
  15.             this.properties = properties;
  16.         }
  18.         @GetMapping(value = "/echo/{string}")
  19.         public String echo(@PathVariable String string) {
  20.             return "Hello PolarisMesh " + string + ", I'm " + properties.getApplicationName();
  21.         }
  22.     }
  23. }
验证
  1. 启动 Spring Boot 应用
  2. 在 Spring Boot 启动日志中，找到如下日志信息, 则表示 Spring Boot 应用已经成功注册到北极星中。
  1. [Polaris] success to register instance 127.0.0.1:28888, service is BootEchoServer, namespace is default
  2. [Polaris] success to schedule heartbeat instance 127.0.0.1:28888, service is BootEchoServer, namespace is default
  1. 可以通过 curl 命令查询服务端是否有该实例。
  1. curl --location --request POST '127.0.0.1:8090/v1/Discover' \
  2. --header 'Content-Type: application/json' \
  3. --data-raw '{
  4.     "type": 1,
  5.     "service": {
  6.         "name": "BootEchoServer",
  7.         "namespace": "default"
  8.     }
  9. }'

服务发现

引入 Spring Cloud Tencent

如果您当前的 Spring Boot 应用还未引入任何 Spring Cloud 依赖，可以将 Spring Boot 调整为 Spring Cloud 项目，使用 Spring Cloud Tencent 中的服务发现能力。

参考文档：Spring Cloud 应用接入SpringBoot应用接入 - 图1 (opens new window)

使用 Spring Boot Polaris Feign

初始化项目

使用 jetbrain idea 等工具初始化一个 maven 项目

引入依赖

在上一步初始化好一个 maven 项目之后，我们在 pom.xml 中引入 Spring Boot Polaris 相关依赖。

  • 引入 spring-boot-polaris-dependencies 进行管理 Spring Boot Polaris 相关组件的依赖版本。
  • 引入 spring-boot-polaris-discovery-starter 实现发现北极星中的服务并进行远程调用。
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  6.     <parent>
  7.         <groupId>org.springframework.boot</groupId>
  8.         <artifactId>spring-boot-starter-parent</artifactId>
  9.         <version>2.4.3</version>
  10.         <relativePath/> <!-- lookup parent from repository -->
  11.     </parent>
  12.     ...
  14.     <dependencyManagement>
  15.         <dependencies>
  16.             <dependency>
  17.                 <groupId>com.tencent.polaris</groupId>
  18.                 <artifactId>spring-boot-polaris-dependencies</artifactId>
  19.                 <version>1.1.0</version>
  20.                 <type>pom</type>
  21.                 <scope>import</scope>
  22.             </dependency>
  23.         </dependencies>
  24.     </dependencyManagement>
  26.     <dependencies>
  27.         <dependency>
  28.             <groupId>org.springframework.boot</groupId>
  29.             <artifactId>spring-boot-starter-web</artifactId>
  30.         </dependency>
  32.         <!-- 引入 Spring Boot Polaris Discovery 依赖用于实现服务注册 -->
  33.         <dependency>
  34.             <groupId>com.tencent.polaris</groupId>
  35.             <artifactId>spring-boot-polaris-discovery-starter</artifactId>
  36.         </dependency>
  37.     </dependencies>
  38.     ...
  39. </project>
配置 application.properties

在 resources 目录下创建 application.properties 文件，并按照如下进行配置

  1. .
  2. ├── java
  3. │   └── com
  4. │       └── example
  5. │           └── springbootpolarisconsumer
  6. │               └── SpringbootConsumerApplication.java
  7. └── resources
  8.     └── application.properties
  1. server.port=38888
  2. spring.application.name=BootEchoConsumer
  3. polaris.address=grpc://127.0.0.1:8091
  4. polaris.discovery.register.enable=true
示例代码
  1. @SpringBootApplication
  2. public class SpringbootconsumerApplication {
  4.     public static void main(String[] args) {
  5.         SpringApplication.run(SpringbootconsumerApplication.class, args);
  6.     }
  8.     @RestController
  9.     static class EchoController {
  11.         private final PolarisFeignBuilder targetBuilder;
  13.         EchoController(PolarisFeignBuilder targetBuilder) {
  14.             this.targetBuilder = targetBuilder;
  15.         }
  17.         @GetMapping(value = "/echo")
  18.         public String echo(@RequestParam(name = "value") String val) {
  19.             EchoServer echoServerBoot = Feign.builder().decoder(new StringDecoder())
  20.                     .addCapability(targetBuilder.buildCircuitBreakCapability())
  21.                     .target(targetBuilder.buildTarget(EchoServer.class,
  22.                             PolarisFeignOptions.build().withService("BootEchoServer")));
  23.             return echoServerBoot.echo(val);
  24.         }
  25.     }
  27.     public interface EchoServer {
  29.         @RequestLine("GET /echo/{value}")
  30.         String echo(@Param("value") String value);
  31.     }
  32. }
验证

通过 curl 命令对服务消费者发起调用。

  1. curl --location --request GET '127.0.0.1:38888/echo?value=hello'

预期的结果如下

  1. Hello PolarisMesh hello, I'm BootEchoServer