Graceful Response是一个Spring Boot体系下的优雅响应处理器，使用Graceful Response进行web接口开发不仅可以节省大量的时间，还可以提高代码质量，使代码逻辑更清晰。
强烈推荐你花3分钟学会它！
本项目案例工程代码：https://github.com/feiniaojin/graceful-response-example.git ，注意选择最新版本的分支。
通常我们进行Java Web API接口时，大部分的Controller代码是这样的：
public class Controller {
@GetMapping("/query")
@ResponseBody
public Response query(Parameter params) {
Response res = new Response();
try {
//1.校验params参数，非空校验、长度校验
if (illegal(params)) {
res.setCode(1);
res.setMsg("error");
return res;
}
//2.调用Service的一系列操作
Data data = service.query(params);
//3.将操作结果设置到res对象中
res.setData(data);
res.setCode(0);
res.setMsg("ok");
return res;
} catch (BizException1 e) {
//4.异常处理：一堆丑陋的try...catch，如果有错误码的，还需要手工填充错误码
res.setCode(1024);
res.setMsg("error");
return res;
} catch (BizException2 e) {
//4.异常处理：一堆丑陋的try...catch，如果有错误码的，还需要手工填充错误码
res.setCode(2048);
res.setMsg("error");
return res;
} catch (Exception e) {
//4.异常处理：一堆丑陋的try...catch，如果有错误码的，还需要手工填充错误码
res.setCode(1);
res.setMsg("error");
return res;
}
}
}这段代码存在什么问题呢？
- 真正的业务逻辑被冗余代码淹没，真正执行业务的代码只有
Data data=service.query(params);其他代码不管是正常执行还是异常处理，都是为了异常封装、把结果封装为特定的格式，例如以下格式：
{
"code": 0,
"msg": "ok",
"data": {
"id": 1,
"name": "username"
}
}这样的逻辑每个接口都需要处理一遍，都是繁琐的重复劳动。
现在，在引入Graceful Response组件后，我们只要直接返回业务结果，Graceful Response即可自动完成response的格式封装。
graceful-response已发布至maven**仓库，可以直接引入到项目中，maven依赖如下：
<dependency>
<groupId>com.feiniaojin</groupId>
<artifactId>graceful-response</artifactId>
<version>2.1</version>
</dependency>目前最新版本为2.1。
@EnableGracefulResponse
@SpringBootApplication
public class ExampleApplication {
public static void main(String[] args) {
SpringApplication.run(ExampleApplication.class, args);
}
}- 普通的查询
@Controller
public class Controller {
@RequestMapping("/get")
@ResponseBody
public UserInfoView get(Long id) {
log.info("id={}", id);
return UserInfoView.builder().id(id).name("name" + id).build();
}
}这个接口直接返回了 UserInfoView的实例对象，调用接口时，Graceful Response将自动封装为以下格式：
{
"status": {
"code": "0",
"msg": "ok"
},
"payload": {
"id": 1,
"name": "name1"
}
}UserInfoView被自动封装到payload字段中。
返回结果的格式是可以自定义的，Graceful Response提供了两种风格的Response，可以通过配置的方式进行切换，如果这两种风格也不能满足需要，我们还可以根据自己的需要进行自定义返回的Response格式。
- 返回值为空的场景
public class Controller {
@RequestMapping("/void")
@ResponseBody
public void testVoidResponse() {
//业务操作
}
}testVoidResponse方法的返回时void，调用这个接口时，将返回：
{
"status": {
"code": "200",
"msg": "success"
},
"payload": {}
}在引入Graceful Response后，Service将：
- 接口直接返回业务数据类型，而不是Response
public interface ExampleService {
UserInfoView query1(Query query);
}- Service接口实现类中，直接抛业务异常，接口调用异常时将直接返回错误码和错误提示
public class ExampleServiceImpl implements ExampleService {
@Resource
private UserInfoMapper mapper;
UserInfoView query1(Query query) {
UserInfo userInfo = mapper.findOne(query.getId());
if (Objects.isNull(userInfo)) {
//这里直接抛自定义异常
throw new NotFoundException();
}
//……后续业务操作
}
}/**
* NotFoundException的定义，使用@ExceptionMapper注解修饰
* code:代表接口的异常码
* msg:代表接口的异常提示
*/
@ExceptionMapper(code = "1404", msg = "找不到对象")
public class NotFoundException extends RuntimeException {
}当Service方法抛出NotFoundException异常时，接口将直接返回错误码，不需要手工set。
{
"status": {
"code": "1404",
"msg": "找不到对象"
},
"payload": {}
}验证：启动example工程后，请求http://localhost:9090/example/notfound
@ExceptionMapper设计的初衷，是将异常与错误码关联起来，用户只需要抛异常，不需要再关注异常与错误码的对应关系。
部分用户反馈，希望在不自定义新异常类的情况下，也能可以按照预期返回错误码和异常信息，因此从2.1版本开始，新增了GracefulResponseException异常类，用户只需要抛出该异常即可。
public class Service {
public void method() {
throw new GracefulResponseException("自定义的错误码","自定义的错误信息");
}
}为简化使用，从2.1版本开始提供了GracefulResponse通用工具类，在需要抛出GracefulResponseException时，只需要调用raiseException方法即可。 这样做的目的是将用户的关注点从异常转移到错误码。
示例如下：
public class Service {
public void method() {
//当condition==true时，抛出GracefulResponseException异常，返回自定义的错误码和错误信息
if (condition) {
GracefulResponse.raiseException("自定义的错误码", "自定义的错误信息");
}
}
}以下是使用Graceful Response进行异常、错误码处理的开发步骤。
创建自定义异常，采用 @ExceptionMapper注解修饰，注解的 code属性为返回码，msg属性为错误提示信息
@ExceptionMapper(code = 1007, msg = "有内鬼，终止交易")
public static final class RatException extends RuntimeException {
}Service执行具体逻辑，需要抛异常的时候直接抛出去即可，不需要在关心异常与错误码关联的问题
public class Service {
public void illegalTransaction() {
//需要抛异常的时候直接抛
if (hasRat()) {
logger.error("有内鬼终止交易");
throw new RatException();
}
doIllegalTransaction();
}
}Controller调用Service
public class Controller {
@RequestMapping("/test3")
public void test3() {
logger.info("test3: RuntimeException");
//Controller中不会进行异常处理，也不会手工set错误码，只关心核心操作，其他的统统交给Graceful Response
exampleService.illegalTransaction();
}
}在浏览器中请求controller的/test3方法，有异常时将会返回：
{
"status": {
"code": 1007,
"msg": "有内鬼，终止交易"
},
"payload": {
}
}案例工程( https://github.com/feiniaojin/graceful-response-example.git )启动后， 通过浏览器访问一个不存在的接口，例如 http://localhost:9090/example/get2?id=1
如果没开启Graceful Response，将会跳转到404页面页面，主要原因是应用内部产生了 NoHandlerFoundException异常。如果开启了Graceful
Response，默认会返回code=1的错误码。
这类非自定义的异常，如果需要自定义一个错误码返回，将不得不对每个异常编写Advice逻辑，在Advice中设置错误码和提示信息，这样做非常繁琐。
Graceful Response可以非常轻松地解决给这类外部异常定义错误码和提示信息的问题。
以下为操作步骤：
- 创建异常别名，并用
@ExceptionAliasFor注解修饰
@ExceptionAliasFor(code = "1404", msg = "not found", aliasFor = NoHandlerFoundException.class)
public class NotFoundException extends RuntimeException {
}code:捕获异常时返回的错误码
msg:为提示信息
aliasFor:表示将成为哪个异常的别名，通过这个属性关联到对应异常。
- 注册异常别名
创建一个继承了AbstractExceptionAliasRegisterConfig的配置类，在实现的registerAlias方法中进行注册。
@Configuration
public class GracefulResponseConfig extends AbstractExceptionAliasRegisterConfig {
@Override
protected void registerAlias(ExceptionAliasRegister aliasRegister) {
aliasRegister.doRegisterExceptionAlias(NotFoundException.class);
}
}- 浏览器访问不存在的URL
再次访问 http://localhost:9090/example/get2?id=1 ,服务端将返回以下json，正是在ExceptionAliasFor中定义的内容
{
"code": "1404",
"msg": "not found",
"data": {
}
}Graceful Response内置了两种风格的响应格式，并通过gr.responseStyle进行配置
- gr.responseStyle=0，或者不配置（默认情况）
将以以下的格式进行返回：
{
"status": {
"code": 1007,
"msg": "有内鬼，终止交易"
},
"payload": {
}
}- gr.responseStyle=1
将以以下的格式进行返回：
{
"code": "1404",
"msg": "not found",
"data": {
}
}- 自定义响应格式 如果以上两种格式均不能满足业务需要，可以通过自定义。
例如以下响应：
public class CustomResponseImpl implements Response {
private String code;
private Long timestamp = System.currentTimeMillis();
private String msg;
private Object data = Collections.EMPTY_MAP;
@Override
public void setStatus(ResponseStatus statusLine) {
this.code = statusLine.getCode();
this.msg = statusLine.getMsg();
}
@Override
@JsonIgnore
public ResponseStatus getStatus() {
return null;
}
@Override
public void setPayload(Object payload) {
this.data = payload;
}
@Override
@JsonIgnore
public Object getPayload() {
return null;
}
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
public Object getData() {
return data;
}
public void setData(Object data) {
this.data = data;
}
public Long getTimestamp() {
return timestamp;
}
}注意，不需要返回的属性可以返回null或者加上@JsonIgnore注解
- 配置
gr.responseClassFullName
将CustomResponseImpl的全限定名配置到gr.responseClassFullName属性。
gr.responseClassFullName=com.feiniaojin.gracefuresponse.example.config.CustomResponseImpl注意，配置gr.responseClassFullName后，gr.responseStyle将不再生效。
-
gr.printExceptionInGlobalAdvice
是否打印异常日志，默认为false
-
gr.responseClassFullName
自定义Response类的全限定名，默认为空。 配置gr.responseClassFullName后，gr.responseStyle将不再生效
-
gr.responseStyle
Response风格，不配置默认为0
-
gr.defaultSuccessCode
自定义的成功响应码，不配置则为0
-
gr.defaultSuccessMsg
自定义的成功提示，默认为ok
-
gr.defaultFailCode
自定义的失败响应码，默认为1
-
gr.defaultFailMsg
自定义的失败提示，默认为error
使用过程中如遇到问题，可以联系作者。
公众号: MarkWord