介绍

项目是基于 Spring boot 的 maven 项目。

  • 新建maven项目
  • 添加项目依赖
  • 添加默认配置文件

创建maven项目

本地新建一个空的 maven 项目choerodon-todo-service。

  1. $ mkdir -p choerodon-todo-service
  2. $ cd choerodon-todo-service

添加项目依赖

创建pom.xml 文件。

  1. $ touch pom.xml

修改pom.xml。

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xmlns="http://maven.apache.org/POM/4.0.0"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <groupId>io.choerodon</groupId>
  6.     <artifactId>choerodon-todo-service</artifactId>
  7.     <version>1.0.0</version>
  8.     <!--choerodon-framework-parent dependency-->
  9.     <parent>
  10.         <groupId>io.choerodon</groupId>
  11.         <artifactId>choerodon-framework-parent</artifactId>
  12.         <version>0.11.0.RELEASE</version>
  13.     </parent>
  14.     <modelVersion>4.0.0</modelVersion>
  16.     <!--choerodon-starters dependency-->
  17.     <properties>
  18.         <choerodon.starters.version>0.11.0.RELEASE</choerodon.starters.version>
  19.         <choerodon.serviceBuild>true</choerodon.serviceBuild>
  20.         <choerodon.mainClass>io.choerodon.todo.TodoServiceApplication</choerodon.mainClass>
  21.     </properties>
  22.     <dependencies>
  23.         <!--spring boot-->
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <artifactId>spring-boot-starter-undertow</artifactId>
  27.         </dependency>
  28.         <dependency>
  29.             <groupId>org.springframework.boot</groupId>
  30.             <artifactId>spring-boot-starter-web</artifactId>
  31.             <exclusions>
  32.                 <exclusion>
  33.                     <groupId>org.springframework.boot</groupId>
  34.                     <artifactId>spring-boot-starter-tomcat</artifactId>
  35.                 </exclusion>
  36.             </exclusions>
  37.         </dependency>
  38.         <dependency>
  39.             <groupId>org.springframework.boot</groupId>
  40.             <artifactId>spring-boot-starter-actuator</artifactId>
  41.         </dependency>
  43.         <!-- 允许注册到注册中心时，添加此依赖 -->
  44.         <!--        &lt;!&ndash;spring cloud&ndash;&gt;-->
  45.         <!--        <dependency>-->
  46.         <!--            <groupId>org.springframework.cloud</groupId>-->
  47.         <!--            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>-->
  48.         <!--        </dependency>-->
  50.         <!--choerodon-->
  51.         <dependency>
  52.             <groupId>io.choerodon</groupId>
  53.             <artifactId>choerodon-starter-core</artifactId>
  54.             <version>${choerodon.starters.version}</version>
  55.         </dependency>
  56.         <dependency>
  57.             <groupId>io.choerodon</groupId>
  58.             <artifactId>choerodon-starter-oauth-resource</artifactId>
  59.             <version>${choerodon.starters.version}</version>
  60.         </dependency>
  61.         <dependency>
  62.             <groupId>io.choerodon</groupId>
  63.             <artifactId>choerodon-starter-swagger</artifactId>
  64.             <version>${choerodon.starters.version}</version>
  65.         </dependency>
  66.         <!-- 配置文件中添加数据库配置后，添加以下依赖 -->
  67.         <!--        <dependency>-->
  68.         <!--            <groupId>io.choerodon</groupId>-->
  69.         <!--            <artifactId>choerodon-starter-mybatis</artifactId>-->
  70.         <!--            <version>${choerodon.starters.version}</version>-->
  71.         <!--        </dependency>-->
  73.         <!--other dependencies-->
  75.         <!--        <dependency>-->
  76.         <!--            <groupId>mysql</groupId>-->
  77.         <!--            <artifactId>mysql-connector-java</artifactId>-->
  78.         <!--        </dependency>-->
  80.         <!-- 添加cpu监控 -->
  81.         <dependency>
  82.             <groupId>io.choerodon</groupId>
  83.             <artifactId>choerodon-starter-metric</artifactId>
  84.             <version>${choerodon.starters.version}</version>
  85.         </dependency>
  90.         <!-- Test Dependencies -->
  91.         <dependency>
  92.             <groupId>org.springframework.boot</groupId>
  93.             <artifactId>spring-boot-starter-test</artifactId>
  94.             <scope>test</scope>
  95.         </dependency>
  96.         <dependency>
  97.             <groupId>io.choerodon</groupId>
  98.             <artifactId>choerodon-liquibase</artifactId>
  99.             <version>${choerodon.starters.version}</version>
  100.             <scope>test</scope>
  101.         </dependency>
  102.         <dependency>
  103.             <groupId>com.h2database</groupId>
  104.             <artifactId>h2</artifactId>
  105.             <version>1.4.197</version>
  106.             <scope>test</scope>
  107.         </dependency>
  108.         <dependency>
  109.             <groupId>org.spockframework</groupId>
  110.             <artifactId>spock-core</artifactId>
  111.             <version>1.1-groovy-2.4-rc-2</version>
  112.             <scope>test</scope>
  113.         </dependency>
  114.         <dependency>
  115.             <groupId>org.spockframework</groupId>
  116.             <artifactId>spock-spring</artifactId>
  117.             <version>1.1-groovy-2.4-rc-3</version>
  118.             <scope>test</scope>
  119.         </dependency>
  122.     </dependencies>
  124.     <build>
  125.         <finalName>choerodon-todo-service</finalName>
  126.     </build>
  128. </project>

根据子级模块所需jar包添加需要的依赖。

  • (必须)choerodon-starter-core，核心工具包。提供了一些基础类用于开发过程中使用。以及主要帮助获取自定义的 userDetail 和一些通用的方法。
  • (必须)choerodon-starter-oauth-resource，oauth资源服务工具包，主要提供了服务controller 的异常统一捕获，并转换成用户语言对应的描述信息，以及配置了服务在接受请求时对jwt token的验证规则。更多choerodon-starter的依赖可以参考choerodon-starters。

添加默认配置文件

在根目录下创建源码文件夹和资源文件夹。

  1. $ mkdir -p src/main/java
  2. $ mkdir -p src/main/resources

项目采用spring boot 进行管理。需要在子项目中配置默认的配置项。

在resource文件夹中创建 application.yml, bootstrap.yml。

  1. $ cd src/main/resources
  2. $ touch application.yml
  3. $ touch bootstrap.yml
  • bootstrap.yml: 存放不会通过环境变量替换和必须在bootstrap中指定的变量。包括项目端口，应用名，config-server地址等。
  • application.yml: 存放项目的基础配置，包含默认的线上数据库连接配置，kafka配置，注册中心地址等，这些变量可以通过profile或者环境变量修改。
  • application-default.yml: 本地开发配置文件，需要将该文件添加到.gitignore。包含本地一些差异化的配置，如数据库连接配置，注册中心地址等。
  1. # bootstrap.yml
  2. server:
  3.   port: 28080
  4. spring:
  5.   application:
  6.     name: choerodon-todo-service
  7.   cloud:
  8.     config:
  9.       failFast: true
  10.       retry:
  11.         maxAttempts: 6
  12.         multiplier: 1.5
  13.         maxInterval: 2000
  14.       uri: localhost:8010
  15.       enabled: false
  16. management:
  17.   server:
  18.     port: 28081
  19.   endpoints:
  20.     web:
  21.       exposure:
  22.         include: '*'
  1. # application.yml
  2. eureka:
  3.   instance:
  4.     preferIpAddress: true
  5.     leaseRenewalIntervalInSeconds: 10
  6.     leaseExpirationDurationInSeconds: 30
  7.     metadata-map:
  8.       VERSION: v1
  9.   client:
  10.     serviceUrl:
  11.       defaultZone: ${EUREKA_DEFAULT_ZONE:http://localhost:8000/eureka/}
  12.     registryFetchIntervalSeconds: 10
  13. mybatis:
  14.   mapperLocations: classpath*:/mapper/*.xml
  15.   configuration: # 数据库下划线转驼峰配置
  16.     mapUnderscoreToCamelCase: true

编写TodoServiceApplication类

在src/main/java中创建TodoServiceApplication。

  1. $ mkdir -p src/main/java/io/choerodon/todo
  2. $ touch src/main/java/io/choerodon/todo/TodoServiceApplication.java

添加main 函数。

  1. package io.choerodon.todo;
  3. import io.choerodon.base.annotation.Permission;
  4. import io.choerodon.resource.annoation.EnableChoerodonResourceServer;
  5. import io.swagger.annotations.ApiOperation;
  6. import org.springframework.boot.SpringApplication;
  7. import org.springframework.boot.autoconfigure.SpringBootApplication;
  8. import org.springframework.http.HttpStatus;
  9. import org.springframework.http.ResponseEntity;
  10. import org.springframework.web.bind.annotation.GetMapping;
  11. import org.springframework.web.bind.annotation.RestController;
  14. @SpringBootApplication
  15. // 是否允许注册到注册中心，暂时注释掉
  16. //@EnableEurekaClient
  17. // 是否开启猪齿鱼资源服务器
  18. @EnableChoerodonResourceServer
  19. @RestController
  20. public class TodoServiceApplication {
  21.     public static void main(String[] args) {
  22.         SpringApplication.run(TodoServiceApplication.class, args);
  23.     }
  25.     @GetMapping
  26.     @Permission(permissionPublic = true)
  27.     @ApiOperation(value = "demo")
  28.     public ResponseEntity<String> hello() {
  29.         return new ResponseEntity<String>("hello world.", HttpStatus.OK);
  30.     }
  31. }

启动应用

项目根目录下执行命令。

  1. $ mvn clean spring-boot:run

控制台打印出如下信息，则表示启动成功。

  1. Started TodoServiceApplication in 8.3 seconds (JVM running for 13.342)

此时可以打开浏览器，在浏览器输入：http://localhost:28081/actuator/health

返回如下信息：

  1. {"status":"UP"}

在浏览器输入：http://localhost:28080/hello，页面打印 hello world.。

这样，一个简单的Spring boot 应用就已经搭建成功。