自定義spring mvc的json視圖實現(xiàn)思路解析
場景
我們團隊現(xiàn)在面臨著多端數(shù)據(jù)接口對接的問題，為了解決這個問題我們定義了接口對接的規(guī)范，
前端（安卓，Ios，web前端）和后端進行了數(shù)據(jù)的格式規(guī)范的討論，確定了json的數(shù)據(jù)格式：
{
"code":"200",
"data":{"":""},
"message":"處理成功"
}
{
"code":"300",
"data":{"":""},
"message":"沒有此用戶"
}
code代表請求處理狀態(tài)：200為正常處理，300為業(yè)務異常處理，500就系統(tǒng)異常處理。
data代表后臺返回的數(shù)據(jù)。
message后臺的提示語，正?；蛘叱晒Φ臅r候會返回錯誤原因。
問題來了
讓每一個人對每一個json視圖的返回值都要進行包裝的話，豈不很麻煩，
這個時候AOP就登場了，我們可以利用aop的思想在請求返回json之后還未response到客戶端時為其包裝上一層。
實現(xiàn)步驟
啟用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 />
創(chuàng)建切面
/**
* json返回切面
* <p>
* 用于處理json返回結果
*
* @author ZhuangJunxiang(529272571@qq.com)
* @Date 2017年4月28日
*/
@Component
@Aspect
@Order(2)
public class JsonReturnAspect {
/**
* 設置分頁默認值
* <p>
* 如果分頁沒有設置值，則默認從系統(tǒng)的配置文件里讀取
*
* @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參數(shù)只有環(huán)繞通知才可以使用JoinPoint的子類ProceedingJoinPoint，
各連接點類型可以調(diào)用代理的方法，并獲取、改變返回值。否則就是用JoinPoint。
情況一：假設conroller類中的函數(shù)不需要任何返回值
比如：我對一個實體對象進行更新我只需要把更新結果返回去就OK了，不需要填充數(shù)據(jù)
返回的數(shù)據(jù)格式：
{
"code":"200",
"data":"",
"message":"處理成功"
}
實現(xiàn)思路：
在切面處理類的處理函數(shù)中獲取到這個函數(shù)的返回值類型如果是void就返回指定格式的數(shù)據(jù)。
上面的isReturnVoid（）就是做這樣的一個判斷。
你只需要將函數(shù)的返回值為void即可：
@RequestMapping
@ResponseBody
public void add(long matchId, Model model) {
slxSignupViewService.setAddInfo(matchId, model);
}
情況二：假設conroller類中的函數(shù)的返回值不需要包裹呢
比如：
某些前端插件以及第三方對接（支付）的返回值是規(guī)定好的,
以及下載文件,我們這些就是多余了，
實現(xiàn)思路：
自定一個@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();
}
在這個切面處理類上判斷這個函數(shù)是否包含這個注解如果包含
就不作處理,原模原樣的返回出去。
JsonReturnAspect類中的isNeedWrap（）方法就是處理這個需求。
總結
以上所述是小編給大家介紹的自定義spring mvc的json視圖實現(xiàn)思路解析，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復大家的。在此也非常感謝大家對腳本之家網(wǎng)站的支持！
相關文章
這篇文章主要給大家介紹了關于Mybatis中連接查詢和嵌套查詢的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-12-12
Java使用DateTimeFormatter格式化輸入的日期時間
這篇文章主要介紹了Java使用DateTimeFormatter格式化輸入的日期時間，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-01-01
這篇文章主要介紹了使用RedisAtomicLong優(yōu)化性能問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-11-11
idea查看properties中文變成unicode碼的解決方案
這篇文章主要介紹了idea查看properties中文變成unicode碼的解決方案,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-06-06
使用@PathVariable注解如何實現(xiàn)動態(tài)傳值
這篇文章主要介紹了使用@PathVariable注解如何實現(xiàn)動態(tài)傳值，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-10-10
springBoot中的CORS跨域注解@CrossOrigin詳解
這篇文章主要介紹了springBoot中的CORS跨域注解@CrossOrigin詳解,通常,服務于?JS?的主機(例如?example.com)與服務于數(shù)據(jù)的主機(例如?api.example.com)是不同的,在這種情況下,CORS?可以實現(xiàn)跨域通信,需要的朋友可以參考下2023-12-12
這篇文章主要介紹了JVM運行時數(shù)據(jù)區(qū)劃分原理詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2021-09-09
有時候會需要將一個ArrayList或者數(shù)組中的數(shù)字打亂，方便后續(xù)使用，比如隨機出題、答案選項打亂、連線題打亂、抽獎號碼打亂等等，把我自己寫的一段代碼貼出來分享給大家。2016-08-08
這篇文章主要介紹了spring 注解開啟聲明式事務問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-12-12
這篇文章主要為大家介紹了Java字節(jié)碼ByteBuddy使用及原理解析上篇，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2023-05-05