1.关于响应结果
控制器处理完请求后,向客户端进行响应时,推荐使用JSON格式的响应数据,并且,此JSON格式的数据中至少应该包括:
- 业务状态码
- 提示信息
在Spring MVC框架中,当需要向客户端响应JSON格式的结果时,需要:
- 当前处理请求的方法必须是“响应正文”的
- 在处理请求的方法或控制器类上使用
@ResponseBody
,或控制器类上使用了@RestController
,就是“响应正文”的
- 在处理请求的方法或控制器类上使用
- 在项目中添加
jackson-databind
的依赖- 包含在
spring-boot-starter-web
依赖项中
- 包含在
- 开启注解驱动
- 使用注解模式的Spring MVC项目(包括Spring Boot)均默认开启
- 使用自定义的类型作为处理请求的方法的返回值类型,并且,此类中应该包含响应的JSON中的各属性
则在项目的根包下创建web.JsonResult
类:
package cn.tedu.csmall.product.web;
import cn.tedu.csmall.product.ex.ServiceCode;
import cn.tedu.csmall.product.ex.ServiceException;
import lombok.Data;
import java.io.Serializable;
@Data
public class JsonResult<T> implements Serializable {
/**
* 业务状态码
*/
private Integer state;
/**
* 错误时的提示消息
*/
private String message;
/**
* 成功时响应的数据
*/
private T data;
public JsonResult() {
}
private JsonResult(Integer state, String message, T data) {
this.state = state;
this.message = message;
this.data = data;
}
public static JsonResult<Void> ok() {
return ok(null);
}
public static <T> JsonResult<T> ok(T data) {
return new JsonResult(ServiceCode.OK.getValue(), null, data);
}
public static JsonResult<Void> fail(ServiceException e) {
return fail(e.getServiceCode().getValue(), e.getMessage());
}
public static JsonResult<Void> fail(Integer state, String message) {
return new JsonResult(state, message, null);
}
}
然后,在处理请求的方法中,使用JsonResult
作为返回值类型,并返回此类型的结果:
@PostMapping("/{id:[0-9]+}/enable")
public JsonResult<Void> setEnable(@PathVariable Long id) {
log.debug("即将处理【启用品牌】的请求,id={}", id);
try {
brandService.setEnable(id);
return JsonResult.ok();
} catch (ServiceException e) {
return JsonResult.fail(e);
}
}
2. 关于处理异常
在Java语言中,异常的体系结构大致是:
Throwable
-- Error
-- -- OutOfMemoryError(OOM)
-- Exception
-- -- IOException
-- -- RuntimeException
-- -- -- NullPointerException(NPE)
-- -- -- ClassCastException
-- -- -- IndexOutOfBoundsException
-- -- -- -- ArrayIndexOutOfBoundsException
-- -- -- -- StringIndexOutOfBoundsException
如果调用的方法抛出了“非RuntimeException
”,则必须:
- 当前方法声明抛出此异常
- 使用
try...catch
代码块包裹此方法的调整代码- 真正意义上的“处理了异常”
关于“处理异常”,需要明确的告诉用户“这次操作失败了,失败的原因是XXXXX,你可以通过XXXXX再次尝试,并避免出现此类错误”!
所以,在整个项目,只有Controller才是适合且必须处理异常的组件,因为它可以将错误的描述文本响应到客户端去,而项目中的其它组件(例如Service等)不适合且不应该处理异常,因为它们不可以直接与客户端进行交互,且如果它们处理了异常,则Controller在调用时将无法知道曾经出现过异常,更加无法处理!