SpringBoot 优化（SpringBoot 全局异常处理，SpringBoot 与 swagger2 的集成）

SpringBoot 全局异常处理

@ControllerAdvice 和@ExceptionHandler

例如

package org.spring.springboot.controller;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
@ControllerAdvice //还可以指定具体的捕获包
public class GlobalExceptionHandler {
@ExceptionHandler(RuntimeException.class) //捕获所有运行时异常
public String exceptionHandler(){
return "error";
}
}

其中涉及到的注解含义及用法如下：

• @ControllerAdvice：该注解是 spring2.3 以后新增的一个注解，主要是用来为 Controller 的一些公共需求的低侵入性增强提供辅助，作用于@RequestMapping 标注的方法上。
• @ExceptionHandler：该注解是配合@ControllerAdvice 一起使用的注解，可以自定义错误处理器，自行组装 json 字符串，并返回到页面。

lombok 的使用

lombok优点：

• 提高编码效率
• 使代码更简洁
• 消除冗长代码
• 避免修改字段名时忘记修改方法名
• 提高逼格
• lombok 默认提供了对 Log4J 和 logback 日志工具的支持。

在 pom.xml 引入 lombok 依赖

<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
<version>1.16.12</version>
</dependency>

lombok 的常用注解

lombok 的优缺点如下：

优点

• 能通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString 等方法，提高了一定的开发效率；
• 让代码变得简洁，不用过多的去关注相应的方法；
• 属性做修改时，也简化了维护为这些属性所生成的 getter/setter方法等。

缺点

• 不支持多种参数构造器的重载；
• 虽然省去了手动创建 getter/setter方法的麻烦，但大大降低了源代码的可读性和完整性，降低了阅读源 代码的舒适度。

SpringBoot 与 swagger2 的集成

SpringBoot 集成 Swagger2 的步骤

首先需要在 pom.xml 文件中添加 Swagger2 的依赖：

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>

控制器类中使用 swagger 注解

• @Api：修饰整个类，描述 Controller 的作用
• @ApiOperation：描述一个类的一个方法，或者说一个接口
• @ApiParam：单个参数描述
• @ApiModel：用对象来接收参数
• @ApiProperty：用对象接收参数时，描述对象的一个字段
• @ApiResponse：HTTP 响应其中 1 个描述
• @ApiResponses：HTTP 响应整体描述
• @ApiIgnore：使用该注解忽略这个 API
• @ApiError ：发生错误返回的信息
• @ApiImplicitParam：一个请求参数
• @ApiImplicitParams：多个请求参数

描述控制器类

swagger 通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。代码如下：

@RestController
public class UserController {
// 创建线程安全的 Map
static Map<Integer, User> users = Collections.synchronizedMap(new HashMap<Integer, User>());
/**
* 根据 ID 查询用户
* @param id
* @return
*/
@ApiOperation(value="获取用户详细信息", notes="根据 url 的 id 来获取用户详细信息")
@ApiImplicitParam(name = "id", value = "用户 ID", required = true, dataType = "Integer", paramType = "path")
@RequestMapping(value = "user/{id}", method = RequestMethod.GET)
public ResponseEntity<JsonResult> getUserById (@PathVariable(value = "id") Integer id){
JsonResult r = new JsonResult();
try {
User user = users.get(id);
r.setResult(user);
r.setStatus("ok");
} catch (Exception e) {
r.setResult(e.getClass().getName() + ":" + e.getMessage());
r.setStatus("error");
e.printStackTrace();
}
return ResponseEntity.ok(r);
}
/**
* 查询用户列表
* @return
*/
@ApiOperation(value="获取用户列表", notes="获取用户列表")
@RequestMapping(value = "users", method = RequestMethod.GET)
public ResponseEntity<JsonResult> getUserList (){
JsonResult r = new JsonResult();
try {
List<User> userList = new ArrayList<User>(users.values());
r.setResult(userList);
r.setStatus("ok");
} catch (Exception e) {
r.setResult(e.getClass().getName() + ":" + e.getMessage());
r.setStatus("error");
e.printStackTrace();
}
return ResponseEntity.ok(r);
}
/**
* 添加用户
* @param user * @return
*/
@ApiOperation(value="创建用户", notes="根据 User 对象创建用户")
@ApiImplicitParam(name = "user", value = "用户详细实体 user", required = true, dataType =
"User")
@RequestMapping(value = "user", method = RequestMethod.POST)
public ResponseEntity<JsonResult> add (@RequestBody User user){
JsonResult r = new JsonResult();
try {
users.put(user.getId(), user);
r.setResult(user.getId());
r.setStatus("ok");
} catch (Exception e) {
r.setResult(e.getClass().getName() + ":" + e.getMessage());
r.setStatus("error");
e.printStackTrace();
}
return ResponseEntity.ok(r);
}
/**
* 根据 id 删除用户
* @param id
* @return
*/
@ApiOperation(value="删除用户", notes="根据 url 的 id 来指定删除用户")
@ApiImplicitParam(name = "id", value = "用户 ID", required = true, dataType = "Long", paramType = "path")
@RequestMapping(value = "user/{id}", method = RequestMethod.DELETE)
public ResponseEntity<JsonResult> delete (@PathVariable(value = "id") Integer id){
JsonResult r = new JsonResult();
try {
users.remove(id);
r.setResult(id);
r.setStatus("ok");
} catch (Exception e) {
r.setResult(e.getClass().getName() + ":" + e.getMessage());
r.setStatus("error");
e.printStackTrace();
}
return ResponseEntity.ok(r);
}
/**
* 根据 id 修改用户信息
* @param user * @return
*/
@ApiOperation(value="更新信息", notes="根据 url 的 id 来指定更新用户信息")
@ApiImplicitParams({
@ApiImplicitParam(name = "id", value = "用户 ID", required = true, dataType =
"Long",paramType = "path"), @ApiImplicitParam(name = "user", value = "用户实体 user", required = true, dataType =
"User")
})
@RequestMapping(value = "user/{id}", method = RequestMethod.PUT)
public ResponseEntity<JsonResult> update (@PathVariable("id") Integer id, @RequestBody User
user){
JsonResult r = new JsonResult();
try {
User u = users.get(id);
u.setUsername(user.getUsername());
u.setAge(user.getAge());
users.put(id, u);
r.setResult(u);
r.setStatus("ok");
} catch (Exception e) {
r.setResult(e.getClass().getName() + ":" + e.getMessage());
r.setStatus("error");
e.printStackTrace();
}
return ResponseEntity.ok(r);
}
@ApiIgnore //使用该注解忽略这个 API
@RequestMapping(value = "/hi", method = RequestMethod.GET)
public String jsonTest() {
100
return " hi you!";
}
}

其中 SpringMVC4.0 以上的版本支持@RequestMapping 的简写方式，如上例代码中的@RequestMapping 可简写为@GetMapping(“user/{id}”)即可。

编写 Swagger 配置类 Swagger2,扫描 SpringMVC 控制器

在配置类中指定将要扫描的 springmvc 控制器的包，代码如下：

@Configuration
public class Swagger2Config {
@Bean
public Docket createRestApi() {
//扫描控制器中 Swagger2 的注解, .apis 里面的参数表示指定包
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select() .apis(RequestHandlerSelectors.basePackage("com.ctt.controller"))
.paths(PathSelectors.any())
.build();
}
//API 描述信息
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("springboot 利用 swagger 构建 api 文档")
.description("简单优雅的 restfun 风格")
.termsOfServiceUrl("http://blog.youkuaiyun.com/saytime")
.version("1.0")
.build();
}
}

SpringBoot 启动类上开启 Swagger2

加上注解@EnableSwagger2 来开启 Swagger，代码如下：

@EnableSwagger2 //启用 Swagger2
@SpringBootApplication
public class Application {
public static void main(String[] args) {
// 程序启动入口
// 启动嵌入式的 Tomcat 并初始化 Spring 环境及其各 Spring 组件
SpringApplication.run(Application.class,args);
}
}

简单的控制器

package com.ctt.controller;

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
@Api(value="用户的控制器")
@RestController
@RequestMapping("/user")
public class UserController {
	@ApiOperation(value="查询用户",notes="获取所有用户信息的方法")
	@PostMapping("/selectAll")
	public void selectAll() {
		
	}
	@ApiOperation(value="添加用户",notes="可以向数据库里添加用户")
	@PostMapping("/add")
	public void add() {
		
	}
}

@RequestMapping注解

	@RequestMapping(value="/路径",method = RequestMethod.PUT)
	@GetMapping("/获取")
	@PutMapping("添加")
	@PostMapping("/创建")
	@DeleteMapping("/删除")

SpringBoot的各种依赖

<!-- MySQL 连接驱动依赖 -->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>${mysql-connector}</version>
		</dependency>
		<!-- lombok 的依赖 -->
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
			<version>1.16.12</version>
		</dependency>
		<!-- 添加 Swagger2 的依赖 -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.6.1</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.6.1</version>
		</dependency>
		<!-- Spring Boot Freemarker 模板 依赖 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-freemarker</artifactId>
		</dependency>
		<!-- 添加 WebSocket 依赖 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-websocket</artifactId>
			<version>1.3.5.RELEASE</version>
		</dependency>