Spring中的那些类——改善代码质量

有没有见过这样的代码?

@PostMapping(value = "/sso/login", consumes = "application/json", produces = "application/json")public CommonResult<String> login() {    /*省略代码*/    return CommonResult.success(true);}

这里的consumes和produces分别代表着这个接口可以消费什么样的请求类型和返回什么样的响应类型,然而,使用这种写法一来难看,二来如果容易写错而且调试起来会比较麻烦。这个时候我们通常会新建一个静态常量类来帮助我们管理这些请求头及相应头的相关静态常量配置。

然而,Spring框架已经帮你想到了这些,今天我们就来介绍下Spring框架帮我们提供的这些有用的封装帮助类~

org.springframework.http包

MediaType

MediaType类是一个媒体类型类,其官方注释为:

A subclass of MimeType that adds support for quality parameters as defined in the HTTP specification.

MimeType的子类,它为在HTTP标准中定义的能力参数提供了支持。

在MediaType类中封装了很多常见的文档类型:

public class MediaType extends MimeType implements Serializable {    /*...*/  public static final String APPLICATION_FORM_URLENCODED_VALUE = "application/x-www-form-urlencoded";  public static final String APPLICATION_JSON_VALUE = "application/json";  public static final String APPLICATION_JSON_UTF8_VALUE = "application/json;charset=UTF-8";  public static final String APPLICATION_PDF_VALUE = "application/pdf";  public static final String APPLICATION_XML_VALUE = "application/xml";  public static final String IMAGE_JPEG_VALUE = "image/jpeg";  public static final String TEXT_HTML_VALUE = "text/html";  /*...*/}

在发送HTTP请求及相应HTTP请求时,经常会用到它们,比如发送时设置的HTTP Request的Accept字段与HTTP Response的Content-Type字段,那么之前的代码我们就可以这样:

@PostMapping(value = "/sso/login", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)public ResponseEntity<Object> login() {    /*...*/    return ResponseEntity.ok();}

基本常见的这些字段都封装在MediaType类中了。

HttpStatus

HttpStatus类是HTTP状态码包装类,其官方注释为:

Enumeration of HTTP status codes.

HTTP 状态码的枚举类

在HttpStatus中封装了很多常见的Http状态码:

public enum HttpStatus {    /*...*/  OK(200, "OK"),  MOVED_PERMANENTLY(301, "Moved Permanently"),  FOUND(302, "Found"),  BAD_REQUEST(400, "Bad Request"),  UNAUTHORIZED(401, "Unauthorized"),  FORBIDDEN(403, "Forbidden"),  NOT_FOUND(404, "Not Found"),  METHOD_NOT_ALLOWED(405, "Method Not Allowed"),  NOT_ACCEPTABLE(406, "Not Acceptable"),  /*...*/}

经常性的,我们会在全局异常捕获里,增加对业务异常的处理,那么此时我们就可以用到这个类了:

@RestControllerAdvicepublic class GlobalException {    @ExceptionHandler(Exception.class)    @ResponseStatus(HttpStatus.BAD_REQUEST)    public ResponseEntity<Object> exception() {        /*...*/        return ResponseEntity.badRequest().build();    }}

像这样,我们可以用HttpStatus.BAD_REQUEST这个常量来处理未处理类型的异常,将相应状态码设置成400。

ResponseEntity

ResponseEntity是封装的一个HTTP响应实体封装类,其官方注释为:

Extension of HttpEntity that adds a HttpStatus status code. Used in RestTemplate as well @Controller methods.

继承HttpEntity类,添加了Http状态码的使用,通常用于RestTemplate的使用场景,同样也在@Controller注解的方法下使用。

官方注释还给出了一些示例:

In RestTemplate, this class is returned by getForEntity() and exchange():    ResponseEntity entity = template.getForEntity("http://example.com", String.class);    String body = entity.getBody();    MediaType contentType = entity.getHeaders().getContentType();    HttpStatus statusCode = entity.getStatusCode();

Can also be used in Spring MVC, as the return value from a @Controller method:    @RequestMapping("/handle")    public ResponseEntity handle() {      URI location = ...;      HttpHeaders responseHeaders = new HttpHeaders();      responseHeaders.setLocation(location);      responseHeaders.set("MyResponseHeader", "MyValue");      return new ResponseEntity("Hello World", responseHeaders, HttpStatus.CREATED);    }

Or, by using a builder accessible via static methods:    @RequestMapping("/handle")    public ResponseEntity handle() {      URI location = ...;      return ResponseEntity.created(location).header("MyResponseHeader", "MyValue").body("Hello World");    }

上面的示例很好看懂,即在RestTemplate场景、Spring MVC场景下的ResponseEntity类的使用。所以说,大家平时编程时点击阅读源代码的时候,下载其源代码并看注释是很有必要的。

HttpHeaders

HttpHeaders类是组装HTTP请求和响应头的类,同时也提供了了一些访问方法,其官方注释为:

A data structure representing HTTP request or response headers, mapping String header names to a list of String values, also offering accessors for common application-level data types.

一种数据结构,表示HTTP请求或响应头,将字符串头名称映射到字符串值列表,也为常见的公共应用级数据类型提供访问器。

其主要封装的常量及访问器如下:

public class HttpHeaders implements MultiValueMap<String, String>, Serializable {    /*...*/    public static final String ACCEPT = "Accept";    public static final String ACCEPT_ENCODING = "Accept-Encoding";    public static final String ACCEPT_LANGUAGE = "Accept-Language";    ACCESS_CONTROL_ALLOW_CREDENTIALS = "Access-Control-Allow-Credentials";    ACCESS_CONTROL_ALLOW_HEADERS = "Access-Control-Allow-Headers";    public static final String ACCESS_CONTROL_ALLOW_METHODS = "Access-Control-Allow-Methods";}

这个类的使用就比较广泛了,基本所有处理HTTP请求和响应的框架都在使用它,如Netty、Tomcat、OKHttp...,这里有必要说明下这个MultiValueMap类,因为我们的请求头经常性的一个Key对多个Value,如Accept字段有可能是application/json、application/xml,所以这个类是帮助我们处理这样特殊结构的泛型封装类。

常见的使用场景是如果我们需要从请求头里取某个值时,比如我们需要根据请求的UA来处理不同的浏览器请求:

@GetMapping("/detail")public ResponseEntity<Object> detail(@RequestHeader(HttpHeaders.USER_AGENT) String ua) {        /*...*/        return ResponseEntity.ok().build();}

其它

该包下面还有很多其他的辅助类,如HttpCookie、CacheControl、HttpMethod等,因为使用方法比较简单,这里就不过多介绍了,感兴趣的可以直接在编程的过程中查看lib包后下载源代码查看~

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

推荐阅读更多精彩内容