多应用+插件架构,代码干净,二开方便,首家独创一键云编译技术,文档视频完善,免费商用码云13.8K 广告
## 一、常用注解回顾 ***** ### 1.1 @RequestBody与@ResponseBody ~~~ //注意并不要求@RequestBody与@ResponseBody成对使用。 public @ResponseBody AjaxResponse saveArticle(@RequestBody ArticleVO article) ~~~ 如上代码所示: * @RequestBody修饰请求参数,注解用于接收HTTP的body,默认是使用JSON的格式 * @ResponseBody修饰返回值,注解用于在HTTP的body中携带响应数据,默认是使用JSON的格式。如果不加该注解,spring响应字符串类型,是跳转到模板页面或jsp页面的开发模式。说白了:加上这个注解你开发的是一个数据接口,不加这个注解你开发的是一个页面跳转控制器。 ![](https://img.kancloud.cn/a3/e0/a3e03e33a39d83822bb56356bc087116_1207x685.png) 在使用@ResponseBody注解之后程序不会再走视图解析器,也就不再做html视图渲染,而是直接将对象以数据的形式(默认JSON)返回给请求发送者。那么我们有一个问题:如果我们想接收或XML数据该怎么办?我们想响应excel的数据格式该怎么办?我们后文来回答这个问题。 ### 1.2. @RequestMapping注解 @RequestMapping注解是所有常用注解中,最有看点的一个注解,用于标注HTTP服务端点。它的很多属性对于丰富我们的应用开发方式方法,都有很重要的作用。如: * value: 应用请求端点,最核心的属性,用于标志请求处理方法的唯一性; * method: HTTP协议的method类型, 如:GET、POST、PUT、DELETE等; * consumes: HTTP协议请求内容的数据类型(Content-Type),例如application/json, text/html; * produces: HTTP协议响应内容的数据类型。下文会详细讲解。 * params: HTTP请求中必须包含某些参数值的时候,才允许被注解标注的方法处理请求。 * headers: HTTP请求中必须包含某些指定的header值,才允许被注解标注的方法处理请求。 ~~~ @RequestMapping(value = "/article", method = POST) @PostMapping(value = "/article") ~~~ 上面代码中两种写法起到的是一样的效果,也就是PostMapping等同于@RequestMapping的method等于POST。同理:@GetMapping、@PutMapping、@DeleteMapping也都是简写的方式。 ### 13. @RestController与@Controller @Controller注解是开发中最常使用的注解,它的作用有两层含义: * 一是告诉Spring,被该注解标注的类是一个Spring的Bean,需要被注入到Spring的上下文环境中。 * 二是该类里面所有被RequestMapping标注的注解都是HTTP服务端点。 @RestController相当于 @Controller和@ResponseBody结合。它有两层含义: * 一是作为Controller的作用,将控制器类注入到Spring上下文环境,该类RequestMapping标注方法为HTTP服务端点。 * 二是作为ResponseBody的作用,请求响应默认使用的序列化方式是JSON,而不是跳转到jsp或模板页面。 ### 1.4. @PathVariable 与@RequestParam PathVariable用于URI上的{参数},如下方法用于删除一篇文章,其中id为文章id。如:我们的请求URL为“/article/1”,那么将匹配DeleteMapping并且PathVariable接收参数id=1。而RequestParam用于接收普通表单方式或者ajax模拟表单提交的参数数据。 ~~~ @DeleteMapping("/article/{id}") public @ResponseBody AjaxResponse deleteArticle(@PathVariable Long id) { @PostMapping("/article") public @ResponseBody AjaxResponse deleteArticle(@RequestParam Long id) { ~~~ ## 二、Http数据转换原理 ***** 序列化与反序列化 ![](https://img.kancloud.cn/37/40/37404a4da1dc198e6b56545d14f78b66_846x289.png) ## 三、自定义HttpMessageConverter ***** 其实绝大多数的数据格式都不需要我们自定义HttpMessageConverter,都有第三方类库可以帮助我们实现(包括下文代码中的Excel格式)。但有的时候,有些数据的输出格式并没有类似于Jackson这种类库帮助我们处理,需要我们自定义数据格式。该怎么做? 下面我们就以Excel数据格式为例,写一个自定义的HTTP类型转换器。实现的效果就是,当我们返回AjaxResponse这种数据类型的话,就自动将AjaxResponse转成Excel数据响应给客户端。 ~~~ <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi-ooxml</artifactId> <version>3.9</version> </dependency> ~~~ ~~~ @Service public class ResponseToXlsConverter extends AbstractHttpMessageConverter<AjaxResponse> { private static final MediaType EXCEL_TYPE = MediaType.valueOf("application/vnd.ms-excel"); ResponseToXlsConverter() { super(EXCEL_TYPE); } @Override protected AjaxResponse readInternal(final Class<? extends AjaxResponse> clazz, final HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException { return null; } //针对AjaxResponse类型返回值,使用下面的writeInternal方法进行消息类型转换 @Override protected boolean supports(final Class<?> clazz) { return (AjaxResponse.class == clazz); } @Override protected void writeInternal(final AjaxResponse ajaxResponse, final HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException { final Workbook workbook = new HSSFWorkbook(); final Sheet sheet = workbook.createSheet(); final Row row = sheet.createRow(0); row.createCell(0).setCellValue(ajaxResponse.getMessage()); row.createCell(1).setCellValue(ajaxResponse.getData().toString()); workbook.write(outputMessage.getBody()); } } ~~~ * 实现AbstractHttpMessageConverter接口 * 指定该转换器是针对哪种数据格式的?如上文代码中的"application/vnd.ms-excel" * 指定该转换器针对那些对象数据类型?如上文代码中的supports函数 * 使用writeInternal对数据进行输出处理,上例中是输出为Excel格式。 在postman中可以使用GET方法测试 ![](https://img.kancloud.cn/ec/4a/ec4a3f62035b5d6b1fcc831170cbe513_1449x544.png) ![](https://img.kancloud.cn/5f/75/5f751a7fe484527316899ce811d7af3e_842x132.png)