自定义spring mvc的json视图实现思路解析

 更新时间:2017年12月13日 10:36:25   作者:王森   我要评论
这篇文章主要介绍了自定义spring mvc的json视图的实现思路解析,本文给大家介绍的非常详细,具有参考借鉴价值,需要的朋友可以参考下

场景

我们团队现在面临着多端数据接口对接的问题,为了解决这个问题我们定义了接口对接的规范,

前端(安卓,Ios,web前端)和后端进行了数据的格式规范的讨论,确定了json的数据格式:

{
"code":"200",
"data":{"":""},
"message":"处理成功"
}
{
"code":"300",
"data":{"":""},
"message":"没有此用户"
}

code代表请求处理状态:200为正常处理,300为业务异常处理,500就系统异常处理。

data代表后台返回的数据。

message后台的提示语,正常或者成功的时候会返回错误原因。

问题来了

让每一个人对每一个json视图的返回值都要进行包装的话,岂不很麻烦,

这个时候AOP就登场了,我们可以利用aop的思想在请求返回json之后还未response到客户端时为其包装上一层。

实现步骤

启用aop

 <!-- base-package 如果多个,用“,”分隔 -->
  <context:component-scan base-package="com.we,cn.isuyang">
    <context:include-filter type="annotation" expression="org.springframework.stereotype.Service" />
    <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller" />
  </context:component-scan>
  <!-- 打开aop 注解 -->
  <aop:aspectj-autoproxy />

创建切面

/**
 * json返回切面
 * <p>
 * 用于处理json返回结果
 *
 * @author  ZhuangJunxiang(529272571@qq.com)
 * @Date   2017年4月28日   
 */
@Component
@Aspect
@Order(2)
public class JsonReturnAspect {
    
  /**
   * 设置分页默认值
   * <p>
   * 如果分页没有设置值,则默认从系统的配置文件里读取
   *
   * @param pjp 切点
  */
  @Around(value = "@annotation(org.springframework.web.bind.annotation.ResponseBody)")
  @Order(1)
  public Object warp(final ProceedingJoinPoint pjp) throws Throwable {
    Object list = pjp.proceed();
    if (isReturnVoid(pjp)) {
      HttpServletResponse response = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes())
          .getResponse();
      if (isNeedWrap(pjp)) {
        response.getWriter().write(JsonUtil.toJson(success("操作成功")));
      }
      return list;
    }
    return data(list);
  }
  /**
   * 是否需要包裹
   *
   * @param pjp 切点
   * 
   * @return true表示不需要
  */
  private boolean isNeedWrap(final ProceedingJoinPoint pjp) {
    Method method = AspectUtil.getMethod(pjp);
    return !method.isAnnotationPresent(Void.class);
  }
  /**
   * 是否返回空
   *
   * @param pjp
   * @return true:返回类型为void,false:返回类型不是void
  */
  private boolean isReturnVoid(ProceedingJoinPoint pjp) {
    Method method = AspectUtil.getMethod(pjp);
    Class<?> returnType = method.getReturnType();
    return "void".equals(returnType.getName());
  } 

  /**
   * 构建成功后的返回对象
   * <p>
   * 消息为空时,不提示,不为空则进行提示
   * 
   * @param message 成功消息
   * @return json对象
   */
  public static Map<String, Object> success(final String message) {
    Map<String, Object> map = MapUtil.map();
    map.put("code", StatusCode.SUCCESS.key());
    map.put("message", message);
    map.put("data","");
    return map;
  }    
  /**
   * 构建成功后的返回对象
   * <p>
   * 消息为空时,不提示,不为空则进行提示
   * 
   * @param message 成功消息
   * @return json对象
   */
  public static Map<String, Object> data(final Object data) {
    Map<String, Object> map = MapUtil.map();
    map.put("code", StatusCode.SUCCESS.key());
    map.put("message", message);
    map.put("data",data);
    return map;
  }    
}

分析一下

@Component 这个注解表示将这个对象交给spring容器进行实例化

@Aspect 表示这是一个切面类

@Around(value = "@annotation(org.springframework.web.bind.annotation.ResponseBody)")

表示凡是方法上带有@ResponseBody注解的都是这个切面中切点,换句话说都会被拦截。

注意:

warp方法中的ProceedingJoinPoint参数只有环绕通知才可以使用JoinPoint的子类ProceedingJoinPoint,

各连接点类型可以调用代理的方法,并获取、改变返回值。否则就是用JoinPoint。

情况一:假设conroller类中的函数不需要任何返回值

比如:我对一个实体对象进行更新我只需要把更新结果返回去就OK了,不需要填充数据

返回的数据格式:

{
"code":"200",
"data":"",
"message":"处理成功"
}

实现思路:

在切面处理类的处理函数中获取到这个函数的返回值类型如果是void就返回指定格式的数据。
上面的isReturnVoid()就是做这样的一个判断。

你只需要将函数的返回值为void即可:

@RequestMapping
@ResponseBody
public void add(long matchId, Model model) {
  slxSignupViewService.setAddInfo(matchId, model);
}

情况二:假设conroller类中的函数的返回值不需要包裹呢

比如:

某些前端插件以及第三方对接(支付)的返回值是规定好的,

以及下载文件,我们这些就是多余了,

实现思路:

自定一个@Void的注解:

/**
 * 空注解
 * <p>
 * 用于标识将controller层中的返回值原模原样的out出去
 * 
 * @author  WangSen(wangsenhehe@126.com)
 * @Date   2017年8月17日   
 */
@Target({ ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Void {
}

在controller层的方法上添加这个注解

 /**
  * 支付完成
  */
@Void
@ResponseBody
@RequestMapping
public void payFinish() throws IOException {
    alipayViewService.payFinish();
}

在这个切面处理类上判断这个函数是否包含这个注解如果包含

就不作处理,原模原样的返回出去。

JsonReturnAspect类中的isNeedWrap()方法就是处理这个需求。

总结

以上所述是小编给大家介绍的自定义spring mvc的json视图实现思路解析,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对脚本之家网站的支持!

相关文章

  • java Tapestry4.1.2入门说明教程

    java Tapestry4.1.2入门说明教程

    不必关心链接!不必关心请求(http request)到了哪里!不必关心响应(http response)要转向哪里!Tapestry构建于底层的request-resonse模式,基于Servlet技术,抽象出面向组件开发的模型。Tapestry关心的是:页面、组件、事件、对象、方法、属性!
    2008-11-11
  • 浅谈java中String与StringBuffer的不同

    浅谈java中String与StringBuffer的不同

    String在栈中,StringBuffer在堆中!所以String是不可变的,数据是共享的。StringBuffer都是独占的,是可变的(因为每次都是创建新的对象!)
    2015-11-11
  • 详解IDEA下Gradle多模块(项目)的构建

    详解IDEA下Gradle多模块(项目)的构建

    这篇文章主要介绍了详解IDEA下Gradle多模块(项目)的构建,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-01-01
  • 老生常谈java垃圾回收算法(必看篇)

    老生常谈java垃圾回收算法(必看篇)

    下面小编就为大家带来一篇老生常谈java垃圾回收算法(必看篇)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-05-05
  • Java生成压缩文件的实例代码

    Java生成压缩文件的实例代码

    在工作过程中,需要将一个文件夹生成压缩文件,然后提供给用户下载。下面通过实例代码给大家介绍Java生成压缩文件的方法,感兴趣的朋友一起看看吧
    2018-06-06
  • java中url汉字编码互相转换实例

    java中url汉字编码互相转换实例

    这篇文章介绍了java中url汉字编码互相转换实例,有需要的朋友可以参考一下
    2013-10-10
  • 解决Eclipse配置Tomcat出现Cannot create a server using the selected type错误

    解决Eclipse配置Tomcat出现Cannot create a server using the se

    这篇文章主要介绍了解决Eclipse配置Tomcat出现Cannot create a server using the selected type错误的相关资料,需要的朋友可以参考下
    2017-02-02
  • java集合——Java中的equals和hashCode方法详解

    java集合——Java中的equals和hashCode方法详解

    本篇文章详细介绍了Java中的equals和hashCode方法详解,Object 类是所有类的父类,非常具有实用价值,需要的朋友可以参考下。
    2016-10-10
  • Spark调度架构原理详解

    Spark调度架构原理详解

    这篇文章主要介绍了Spark 调度架构原理详解,具有一定借鉴价值,需要的朋友可以参考下。
    2017-12-12
  • eclipse下配置Spring环境的方法步骤

    eclipse下配置Spring环境的方法步骤

    这篇文章主要介绍了eclipse下配置Spring环境的方法步骤,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-07-07

最新评论