我们经常都需要封装统一JSON格式 例如以下形式
{
“data”:“输出的数据”,
“code”:“响应代码”,
“msg”:“响应信息”
}
/**
* Created by linli on 2017/7/31.
*/
public class Result<T> {
String code;
String msg;
T data;
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 T getData() {
return data;
}
public void setData(T data) {
this.data = data;
}
}
而我们经常是这么做的 new Result<>() 返回;
@ResponseBody
@RequestMapping("/test")
public Result<BusinessResult> test() {
//模拟业务成返回数据
Result<BusinessResult> result = new Result<>();
return result;
}
这样做看起来好像没有什么不对,我已经通过 Result 封装了我的数据格式,返回去的结果是统一的。
但是我们仔细想想 ,我每个接口,每个Service ,每个业务实现类都要 返回一个 Result 这是不是重复的工作,可不可以统一封装呢?
重复的工作我们都应该想办法避免。
而且再仔细想想 们的业务Service ,注重点是完成我们的业务工作而不是花费大量的时间在 new Result() 上。
这样是三层架构的精髓。每一层都负责不一样的事情,尽可能的处理与自己关注点,避免无干的事情,
Service 的重点就是业务,而封装数据应该由Contrller 完成。
思想很重!!!!
于是我们想办法把他简化,正确的做法应该是这样的:
@ResponseBody
@RequestMapping("/test")
public BusinessResult test() {
//模拟业务成返回数据
BusinessResult result = new BusinessResult();
return result;
}
我们的返回结果应该是我们的业务数据,封装数据 由spring mvc 控制层完成。
HttpMessageConverter 是 Spring3.0 新添加的一个接口,负责将请求信息转换为一个对象(类型为 T),将对象(类型为 T)输出为响应信息。
MappingJackson2HttpMessageConverter ,FastJsonHttpMessageConverter 等都是通过继承
HttpMessageConverter 达到json 转换效果, 有兴趣的同学可以看看源码。
我们也可以利用 重写 MappingJackson2HttpMessageConverter 或 FastJsonHttpMessageConverter 达到我们的 统一数据输出:
/**
* Created by Administrator on 2017/6/14.
* 全局数据 统一输出
*/
public class GlobalMessageConverter extends MappingJackson2HttpMessageConverter {
public static Logger logger = LoggerFactory.getLogger(GlobalMessageConverter.class);
/**
* 写出数据
*
* @param object
* @param type
* @param outputMessage
* @throws IOException
* @throws HttpMessageNotWritableException
*/
@Override
protected void writeInternal(Object object, Type type, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
//Result 类型的 不用处理
if (object instanceof Result ) {
super.writeInternal(object, type, outputMessage);
return;
}
Result<Object> baseRes = new Result<>();
baseRes.setData(object);
baseRes.setMsg("操作成功");
baseRes.setCode(0);
logger.info("输出参数:" + JsonUtil.toJson(baseRes));
super.writeInternal(baseRes, Result.class, outputMessage);
}
@Override
protected void init(ObjectMapper objectMapper) {
super.init(objectMapper);
getObjectMapper().setSerializationInclusion(JsonInclude.Include.NON_NULL);
}
@Override
protected boolean supports(Class<?> clazz) {
return super.supports(clazz);
}
@Override
public void setSupportedMediaTypes(List<MediaType> supportedMediaTypes) {
super.setSupportedMediaTypes(supportedMediaTypes);
}
}
spring boot 配置 HttpMessageConverter:
@EnableFeignClients
@SpringBootApplication
@Configuration
@EnableEurekaClient
@EnableScheduling
@EnableHystrix
public class MicroBlogArticleCommentsServiceApplication {
public static void main(String[] args) {
SpringApplication.run(MicroBlogArticleCommentsServiceApplication.class, args);
}
@Bean
@LoadBalanced
public RestTemplate restTemplate() {
return new RestTemplate();
}
@Bean
public HttpMessageConverters fastJsonHttpMessageConverters() {
GlobalMessageConverter converter = new GlobalMessageConverter();
return new HttpMessageConverters(converter);
}
}
细心的同学可能会发现,如果我发生错误需要返回错误类型的 Result 怎么办? 你这样只能返回正确结果的Result(业务正常的Result),要是业务失败,如密码错误,用户不存在等怎么处理?