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序列化类。
总之啦,方法有多种,实用为上。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容