kuramoto/spring-boot-rest

Spring Boot "微服务"示例项目

这是一个基于Java/Maven/Spring Boot（版本1.5.6）的示例应用，可作为创建微服务的启动模板，内置健康检查、指标监控等功能。

如何运行

该应用打包为包含嵌入式Tomcat 8的war包，无需单独安装Tomcat或JBoss，可通过java -jar命令运行：

• 克隆此仓库
• 确保使用JDK 1.8和Maven 3.x
• 构建项目并运行测试：mvn clean package
• 构建成功后，可通过以下两种方式运行服务：

java -jar -Dspring.profiles.active=test target/spring-boot-rest-example-0.5.0.war
或
mvn spring-boot:run -Drun.arguments="spring.profiles.active=test"

• 检查stdout或boot_example.log文件，确保无异常抛出

应用运行后，将看到类似输出：

2017-08-29 17:31:23.091  INFO 19387 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8090 (http)
2017-08-29 17:31:23.097  INFO 19387 --- [           main] br.com.mvcs.example.Application        : Started Application in 22.285 seconds (JVM running for 23.032)

如何构建Docker镜像

执行以下命令创建镜像：

命令：
docker build -t <镜像名称>:<标签> .

示例：
docker build -t devops-mvcs:1.0 .

查看Dockerfile最后一步：

CMD ["java", "-jar", "-Dspring.profiles.active=test", "/opt/spring-boot-rest/target/spring-boot-rest-example.jar"]

该镜像将使用test配置文件运行项目。

如何用Docker运行镜像

执行以下命令运行镜像：

命令：
docker run -d -p 8090:8090 -p 8091:8091 <镜像名称>:<标签>

示例：
docker run -d -p 8090:8090 -p 8091:8091 devops-mvcs:1.0

关于服务

该服务是一个简单的酒店评论REST服务，使用内存数据库（H2）存储数据，也可适配MySQL或PostgreSQL等关系型数据库。若数据库连接配置正确，可在8090端口调用br.com.mvcs.example.api.rest.hotelController中定义的REST端点。

更重要的是，可调用8091端口的运维端点，如/metrics和/health（完整列表见下文）。

此示例应用展示了：

• 与最新Spring框架的完整集成：控制反转、依赖注入等
• 打包为含嵌入式容器（Tomcat 8）的单war包：无需在主机单独安装容器，直接用java -jar运行
• 自动配置健康检查、指标、信息等端点：只需几行代码即可注入自定义健康/指标信息
• 使用注解编写RESTful服务：支持XML和JSON请求/响应，只需在请求中使用所需的Accept头
• 应用异常到HTTP响应的映射：响应体包含异常详情
• Spring Data与JPA/Hibernate的集成：只需少量配置和熟悉的注解
• 使用Spring Repository模式实现对数据源的自动CRUD功能
• MockMVC测试框架及相关库的使用
• 通过Swagger2注解实现API自文档化

以下是可调用的端点：

查看系统健康、配置等信息

http://localhost:8091/env
http://localhost:8091/health
http://localhost:8091/info
http://localhost:8091/metrics

创建酒店资源

POST /example/v1/hotels
Accept: application/json
Content-Type: application/json

{
"name" : "Beds R Us",
"description" : "Very basic, small rooms but clean",
"city" : "Santa Ana",
"rating" : 2
}

响应：HTTP 201 (Created)
Location头：http://localhost:8090/example/v1/hotels/1

获取酒店分页列表

http://localhost:8090/example/v1/hotels?page=0&size=10

响应：HTTP 200
内容：分页列表

更新酒店资源

PUT /example/v1/hotels/1
Accept: application/json
Content-Type: application/json

{
"name" : "Beds R Us",
"description" : "Very basic, small rooms but clean",
"city" : "Santa Ana",
"rating" : 3
}

响应：HTTP 204 (No Content)

查看Swagger 2 API文档

运行服务后，访问http://localhost:8090/swagger-ui.html

关于Spring Boot

Spring Boot是一个“约定优于配置”的应用启动框架，易于创建新的RESTful服务（及其他类型应用）。它提供许多常用的Spring功能，通常无需任何XML即可轻松配置。除了Spring控制器、Spring Data等的便捷设置外，Spring Boot还包含Actuator模块，为应用提供以下有助于监控和运维的端点：

/metrics 显示当前应用的“指标”信息
/health 显示应用健康信息
/info 显示任意应用信息
/configprops 显示所有@ConfigurationProperties的 collation列表
/mappings 显示所有@RequestMapping路径的 collation列表
/beans 显示应用中所有Spring Beans的完整列表
/env 暴露Spring ConfigurableEnvironment的属性
/trace 显示跟踪信息（默认是最近的几个HTTP请求）

查看H2内存数据库

'test'配置文件使用H2内存数据库。要查看和查询数据库，可访问http://localhost:8090/h2-console。默认用户名是'sa'，密码为空。请确保在生产配置中禁用此功能。更多信息见https://goo.gl/U8m62X

用MySQL运行项目

该项目使用内存数据库，无需安装数据库即可运行。但转换为使用MySQL或PostgreSQL等其他关系型数据库非常容易。由于项目使用Spring Data和Repository模式，甚至可以轻松用MongoDB支持相同服务。

以下是用MySQL支持服务的步骤：

在pom.xml中添加依赖：

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>

在application.yml末尾追加：

---
spring:
  profiles: mysql

  datasource:
    driverClassName: com.mysql.jdbc.Driver
    url: jdbc:mysql://<你的MySQL主机或IP>/bootexample
    username: <你的MySQL用户名>
    password: <你的MySQL密码>

  jpa:
    hibernate:
      dialect: org.hibernate.dialect.MySQLInnoDBDialect
      ddl-auto: update # 注意：在非开发环境中，注释此行

hotel.service:
  name: 'test profile:'

使用'mysql'配置文件运行：

java -jar -Dspring.profiles.active=mysql target/spring-boot-rest-example-0.5.0.war
或
mvn spring-boot:run -Drun.jvmArguments="-Dspring.profiles.active=mysql"

从IDE远程附加到应用

用以下命令行选项运行服务：

mvn spring-boot:run -Drun.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005"
或
java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -Dspring.profiles.active=test -Ddebug -jar target/spring-boot-rest-example-0.5.0.war

然后可通过IDE远程连接。例如，在IntelliJ中添加远程调试配置：编辑配置 -> Remote。