SpringMVC controller輸入、輸出處理

以RESTful應用為前提,在controller方法中,往往要注入一些固定的對象,如當前用戶、權限信息等。而且還要返回固定格式的數據以供前端處理,這里介紹一些常在項目中使用的處理方法。

注入自定義參數

如下接口用來獲取當前用戶的地址信息,可以直接在方法中注入用戶對象,然而spring參數Resolver并不能直接解析出SessionUserBean,用戶信息可能存儲于緩存中,通過token標示獲取。

//SessionUserBean用來存儲與表示當前回話用戶信息
public class SessionUserBean {     
private Integer userId;
}

@RequestMapping("/address")
public void getAddress(SessionUserBean sessionUser){
//do something
}

可以通過實現HandlerMethodArgumentResolver來定義自己的處理器:

public class SessionUseResolver implements HandlerMethodArgumentResolver {   

@Override    
public boolean supportsParameter(MethodParameter methodParameter) {
//只處理指定的對象       
 return methodParameter.getParameterType().equals(SessionUserBean.class);  
}

@Override    
public Object resolveArgument(MethodParameter methodParameter, ModelAndViewContainer modelAndViewContainer, NativeWebRequest nativeWebRequest, WebDataBinderFactory webDataBinderFactory) throws Exception {        
HttpServletRequest req = (HttpServletRequest) nativeWebRequest.getNativeRequest();
//這里通過HttpServletRequest的某些頭信息獲取用戶信息
SessionUserBean sessionUser = SessionUserUtil.getSessionUser(req);       
return sessionUser;    
}
}

在springboot項目中可通過配置類注冊解析器,xml配置方法也是類似方式。

@Configurationpublic 
class WebMvcConfig extends WebMvcConfigurerAdapter {      
@Override    
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {        
argumentResolvers.add(new SessionUseResolver());      
//...
}

之后便可以在任何需要注入的controller方法中注入對象了。

統一封裝返回值

假定api統一的返回數據類型如下:

public class ResponseVo {    
private String message;   
private Object data;   //接口處理結果 
private String code = "200";  //狀態嗎,正常時為200,否則為異常碼
}

我們期望在在controller方法中直接返回業務對象(非ResponseVo對象)或者是不返回任何東西(也代表處理成功),但是最終http請求相應的數據仍未統一的格式,那么可以用@ControllerAdvice來簡單的實現我們的需求。

@ControllerAdvice
public class ResponseVoAdvice implements ResponseBodyAdvice<Object> {    
@Autowired   
private HttpServletRequest httpServletRequest;    
@Autowired    
private Environment environment;    
@Override    
public boolean supports(MethodParameter returnType, Class converterType) {        
  if (returnType.getMethodAnnotation(RequestMapping.class) != null) {            
    String typeName = returnType.getGenericParameterType().getTypeName();            
   //只處理非 ResponseVo 的返回值類型,包括void類型也會被處理
   if (!StringUtils.equals(typeName, ResponseVo.class.getTypeName())) {                
      return true;            
    }        
  }        
  return false;    
}   
@Override   
public Object beforeBodyWrite(Object body, 
  MethodParameter returnType, 
  MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, 
  ServerHttpRequest request, 
  ServerHttpResponse response) {        
  if (body instanceof MappingJacksonValue) {            
    MappingJacksonValue mv = (MappingJacksonValue) body;            
    //構建結果對象
    ResponseVo success = ResponseVo.success(mv.getValue());            
    if (EnvironmentUtil.isTestEvn(environment)) { 
    //測試環境下加入debug信息      
        success.set_debug(httpServletRequest.getAttribute(SYSTEM.RESPONSE_DEBUG));            
    }            
    return success;        
    } else {            
      return body;        
    }    
 }
}

上面的示例中只處理正常情況下的數據封裝,當業務出現異常時,會由異常處理器統一處理返回結果。

還有更多

以上就是一些對于controller方法輸入、輸出處理的小case,事實上有無數種方法可以達到同樣的效果,如修改默認的json序列化類。
總之啦,方法有多種,實用為上。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容