《SpringCloud超级入门》Spring Boot项目搭建步骤（超详细）《六
自定义 actuator 端点
统一异常处理
异步执行
随机端口
编译打包
在 Spring Tools 4 for Eclipse 中选择 File->New->Maven Project，
在 pom.xml 中添加 Spring Boot 的依赖，
org.springframework.boot
spring-boot-starter-parent
2.0.6.RELEASE
org.springframework.boot
spring-boot-starter-web
编写启动类，代码如下。
@SpringBootApplication
public class App {
public static void main(String[] args) {
SpringApplication.run(App.class, args);
}
}
启动类使用了 @SpringBootApplication 注解，这个注解表示该类是一个 Spring Boot 应用。直接运行 App 类即可启动，启动成功后在控制台输出信息，默认端口是 8080
Spring Boot启动成功
我们只在 pom.xml 中引入了一个 Web 的 Starter，然后创建一个普通的 Java 类，一个 Main 方法就可以启动一个 Web 项目。
与之前的使用方式相比，这种方式简单很多。以前需要配置各种 Spring 相关的包，还需要配置 web.xml 文件，还需要将项目放入 Tomcat 中去执行，搭建项目的过程还特别容易出错，会出现各种 jar 包冲突。有了 Spring Boot 后这些问题都解决了。
我们之所以能够通过一个 Main 方法启动一个 Web 服务，是因为 Sprig Boot 中内嵌了 Tomcat，然后通过内嵌的 Tomcat 来提供服务。当然，我们也可以使用别的容器来替换 Tomcat，比如 Undertow 或 Jetty。
编写第一个 REST 接口
创建一个控制器，编写第一个 REST 接口，访问地址使用 /hello，代码如下。
@RestController
public class HelloController {
@GetMapping(“/hello”)
public String hello() {
return “hello”;
}
}
@RestController 是 @Controller 和 @ResponseBody 的组合注解，可以直接返回 Json 格式数据。
运行结果
读取配置文件
在以前的项目中我们主要在 XML 文件中进行框架配置，业务的相关配置会放在属性文件中，然后通过一个属性读取的工具类来读取配置信息。
Spring Boot 中的配置通常放在 application.properties 中，读取配置信息非常方便，总共分为 3 种方式。
1）Environment
可以通过 Environment 的 getProperty 方法来获取想要的配置信息，代码如下所示。
@RestController
public class HelloController {
// 注入对象
@Autowired
private Environment env;
@GetMapping(“/hello”)
public String hello() {
// 读取配置
《一线大厂Java面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义》无偿开源 威信搜索公众号【编程进阶路】 String port = env.getProperty(“server.port”);
return port;
}
}
2）@Value
可以注入具体的配置信息，代码如下。
@RestController
public class HelloController {
// 注入配置
@Value(“${server.port}”)
private String port;
@GetMapping(“/hello”)
public String hello() {
return port;
}
}
3）自定义配置类
prefix 定义配置的前缀，代码如下。
@ConfigurationProperties(prefix = “net.biancheng”)
@Component
public class MyConfig {
private String name;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
读取配置的方法代码如下。
@RestController
public class HelloController {
@Autowired
private MyConfig myConfig;
@GetMapping(“/hello”)
public String hello() {
return myConfig.getName();
}
}
定义配置 application.properties 的方法如下：
net.biancheng.name=zhangsan
profiles 多环境配置
在平时的开发中，项目会被部署到测试环境、生产环境，但是每个环境的数据库地址等配置信息都是不一样的。通过 profile 来激活不同环境下的配置文件就能解决配置信息不一样的问题。在 Spring Boot 中可以通过 spring.profiles.active=dev 来激活不同环境下的配置。
可以定义多个配置文件，每个配置文件对应一个环境，格式为 application-环境.properties，如表 1 所示。
在开发环境中，可以通过修改 application.properties 中的 spring.profiles.active 的值来激活对应环境的配置，在部署的时候可以通过 java–jar xxx.jar–spring.profiles.active=dev 来指定使用对应的配置。
热部署
开发过程中经常会改动代码，此时若想看下效果，就不得不停掉项目然后重启。
对于 Spring Boot 项目来说，启动时间是非常快的，在微服务的架构下，每个服务只关注自己的业务，代码量也非常小，这个启动时间是可以容忍的。
通过 spring-boot-devtools 就可以实现热部署。
只需要添加 spring-boot-devtools 的依赖即可实现热部署功能，代码如下所示。
org.springframework.boot
spring-boot-devtools
actuator 监控
Spring Boot 提供了一个用于监控和管理自身应用信息的模块，它就是 spring-boot-starter-actuator。该模块使用起来非常简单，只需要加入依赖即可，代码如下。
org.springframework.boot
spring-boot-starter-actuator
启动项目我们会发现在控制台输出的内容中增加了 所示的信息。
比如，我们访问 /actuator/health 可以得到下面的信息：
{
“status”: “UP”
}
Spring Boot启动控制台输出
Actuator端点信息
UP 表示当前应用处于健康状态，如果是 DOWN 就表示当前应用不健康。增加下面的配置可以让一些健康信息的详情也显示出来：
management.endpoint.health.show-details=ALWAYS
再次访问 /actuator/health，就可以得到健康状态的详细信息数据：
{
“status”: “UP”,
“diskSpace”: {
“status”: “UP”,
“total”: 491270434816,
“free”: 383870214144,
“threshold”: 10485760
}
}
大部分端点默认都不暴露出来，我们可以手动配置需要暴露的端点。如果需要暴露多个端点，可以用逗号分隔，如下所示：
management.endpoints.web.exposure.include=configprops,beans
如果想全部端点都暴露的话直接配置成下面的方式：
management.endpoints.web.exposure.include=*
后面我们会介绍如何使用 Spring Boot Admin在页面上更加直观地展示这些信息，目前都是 Json 格式的数据，不方便查看。
自定义 actuator 端点
我们需要自定义一些规则来判断应用的状态是否健康，可以采用自定义端点的方式来满足多样性的需求。如果我们只是需要对应用的健康状态增加一些其他维度的数据，可以通过继承 AbstractHealthIndicator 来实现自己的业务逻辑。代码如下。
@Component
public class UserHealthIndicator extends AbstractHealthIndicator {
@Override
protected void doHealthCheck(Builder builder) throws Exception {
builder.up().withDetail(“status”, true);
// builder.down().withDetail(“status”, false);
}
}
通过 up 方法指定应用的状态为健康，down 方法指定应用的状态为不健康。withDetail 方法用于添加一些详细信息。访问 /actuator/health，可以得到我们自定义的健康状态的详细信息：
{
“status”: “UP”,
“details”: {
“user”: {
“status”: “UP”,
“details”: {
“status”: true
}
},
“diskSpace”: {
“status”: “UP”,
“details”: {
“total”:
249795969024,
“free”: 7575375872,
“threshold”: 10485760
}
}
}
}
上面我们是在框架自带的 health 端点中进行扩展，还有一种需求是完全开发一个全新的端点，比如查看当前登录的用户信息的端点。自定义全新的端点很简单，通过 @Endpoint 注解就可以实现。代码如下所示。
@Component
@Endpoint(id = “user”)
public class UserEndpoint {
@ReadOperation
public List
List
Map
map.put(“userId”, 1001);
map.put(“userName”, “zhangsan”);
list.add(map);
return list;
}
}
访问 /actuator/user 可以看到返回的用户信息如下：
[
{
“userName”: “zhangsan”,
“userId”: 1001
}
]
统一异常处理
对于接口的定义，我们通常会有一个固定的格式
{
“status”: true,
“code”: 200,
“message”: null,
“data”: [
{
“id”: “101”,
“name”: “jack”
},
{
“id”: “102”,
“name”: “jason”
}
]
}
如果调用方在请求我们的 API 时把接口地址写错了，就会得到一个 404 错误：
{
“timestamp”: 1492063521109,
“status”: 404,
“error”: “Not Found”,
“message”: “No message available”,
“path”: “/rest11/auth”
}
后端服务会告诉我们哪个地址没找到，其实也挺友好。但是因为我们上面自定义的数据格式跟下面的不一致，所以当用户拿到这个返回的时候是无法识别的，其中最明显的是 status 字段。
我们自定义的是 boolean 类型，用来表示请求是否成功，这里返回的就是 Http 的状态码，所以我们需要在发生这种系统错误时也能返回我们自定义的那种格式，那就要定义一个异常处理类（代码如下所示），通过这个类既可以返回统一的格式，也可以统一记录异常日志。
@ControllerAdvice
public class GlobalExceptionHandler {
private Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
@ExceptionHandler(value = Exception.class)
@ResponseBody
public ResponseData defaultErrorHandler(HttpServletRequest req, Exception e) throws Exception {
logger.error(“”, e);
ResponseData r = new ResponseData();
r.setMessage(e.getMessage());
if (e instanceof org.springframework.web.servlet.NoHandlerFoundException) {
r.setCode(404);
} else {
r.setCode(500);
}
r.setData(null);
r.setStatus(false);
return r;
}
}
ResponseData 是我们返回格式的实体类，其发生错误时也会被捕获到，然后封装好返回格式并返回给调用方。在 Spring Boot 的配置文件中加上如下代码所示配置。
出现错误时, 直接抛出异常
spring.mvc.throw-exception-if-no-handler-found=true
不要为我们工程中的资源文件建立映射
spring.resources.add-mappings=false
当我们调用一个不存在的接口时，返回的错误信息就是我们自定义的那种格式：