注意：本節(jié)內(nèi)容需要結(jié)合spring常用注解開(kāi)發(fā)一個(gè)RESTful接口示例 內(nèi)容聯(lián)合起來(lái)一起看，然后理解

一、HTTP協(xié)議的四種傳參方式

二、常用注解回顧

2.1 @RequestBody與@ResponseBody

//注意并不要求@RequestBody與@ResponseBody成對(duì)使用。
public @ResponseBody  AjaxResponse saveArticle(@RequestBody ArticleVO article)

如上代碼所示：

• @RequestBody修飾請(qǐng)求參數(shù)，注解用于接收HTTP的body，默認(rèn)是使用JSON的格式
• @ResponseBody修飾返回值，注解用于在HTTP的body中攜帶響應(yīng)數(shù)據(jù)，默認(rèn)是使用JSON的格式。如果不加該注解，spring響應(yīng)字符串類型，是跳轉(zhuǎn)到模板頁(yè)面或jsp頁(yè)面的開(kāi)發(fā)模式。說(shuō)白了：加上這個(gè)注解你開(kāi)發(fā)的是一個(gè)數(shù)據(jù)接口，不加這個(gè)注解你開(kāi)發(fā)的是一個(gè)頁(yè)面跳轉(zhuǎn)控制器。

在使用@ResponseBody注解之后程序不會(huì)再走視圖解析器，也就不再做html視圖渲染，而是直接將對(duì)象以數(shù)據(jù)的形式（默認(rèn)JSON）返回給請(qǐng)求發(fā)送者。那么我們有一個(gè)問(wèn)題：如果我們想接收或XML數(shù)據(jù)該怎么辦？我們想響應(yīng)excel的數(shù)據(jù)格式該怎么辦？我們后文來(lái)回答這個(gè)問(wèn)題。

2.2. @RequestMapping注解

@RequestMapping注解是所有常用注解中，最有看點(diǎn)的一個(gè)注解，用于標(biāo)注HTTP服務(wù)端點(diǎn)。它的很多屬性對(duì)于豐富我們的應(yīng)用開(kāi)發(fā)方式方法，都有很重要的作用。如：

value： 應(yīng)用請(qǐng)求端點(diǎn)，最核心的屬性，用于標(biāo)志請(qǐng)求處理方法的唯一性；

method： HTTP協(xié)議的method類型， 如：GET、POST、PUT、DELETE等；

consumes： HTTP協(xié)議請(qǐng)求內(nèi)容的數(shù)據(jù)類型（Content-Type），例如application/json, text/html;

produces: HTTP協(xié)議響應(yīng)內(nèi)容的數(shù)據(jù)類型。下文會(huì)詳細(xì)講解。

params： HTTP請(qǐng)求中必須包含某些參數(shù)值的時(shí)候，才允許被注解標(biāo)注的方法處理請(qǐng)求。

headers： HTTP請(qǐng)求中必須包含某些指定的header值，才允許被注解標(biāo)注的方法處理請(qǐng)求。

@RequestMapping(value = "/article", method = POST)
@PostMapping(value = "/article")

上面代碼中兩種寫法起到的是一樣的效果，也就是PostMapping等同于@RequestMapping的method等于POST。同理：@GetMapping、@PutMapping、@DeleteMapping也都是簡(jiǎn)寫的方式。

2.3. @RestController與@Controller

@Controller注解是開(kāi)發(fā)中最常使用的注解，它的作用有兩層含義：

• 一是告訴Spring，被該注解標(biāo)注的類是一個(gè)Spring的Bean，需要被注入到Spring的上下文環(huán)境中。
• 二是該類里面所有被RequestMapping標(biāo)注的注解都是HTTP服務(wù)端點(diǎn)。

@RestController相當(dāng)于 @Controller和@ResponseBody結(jié)合。它有兩層含義：

• 一是作為Controller的作用，將控制器類注入到Spring上下文環(huán)境，該類RequestMapping標(biāo)注方法為HTTP服務(wù)端點(diǎn)。
• 二是作為ResponseBody的作用，請(qǐng)求響應(yīng)默認(rèn)使用的序列化方式是JSON，而不是跳轉(zhuǎn)到j(luò)sp或模板頁(yè)面。

2.4. @PathVariable 與@RequestParam

PathVariable用于URI上的{參數(shù)}，如下方法用于刪除一篇文章，其中id為文章id。如：我們的請(qǐng)求URL為“/article/1”,那么將匹配DeleteMapping并且PathVariable接收參數(shù)id=1。而RequestParam用于接收普通表單方式或者ajax模擬表單提交的參數(shù)數(shù)據(jù)。

@DeleteMapping("/article/{id}")
public @ResponseBody AjaxResponse deleteArticle(@PathVariable Long id) {
@PostMapping("/article")
public @ResponseBody AjaxResponse deleteArticle(@RequestParam Long id) {

二、接收復(fù)雜嵌套對(duì)象參數(shù)

有一些朋友可能還無(wú)法理解RequestBody注解存在的真正意義，表單數(shù)據(jù)提交用RequestParam就好了，為什么還要搞出來(lái)一個(gè)RequestBody注解呢？RequestBody注解的真正意義在于能夠使用對(duì)象或者嵌套對(duì)象接收前端數(shù)據(jù)。

仔細(xì)看上面的代碼，是一個(gè)paramData對(duì)象里面包含了一個(gè)bestFriend對(duì)象。這種數(shù)據(jù)結(jié)構(gòu)使用RequestParam就無(wú)法接收了，RequestParam只能接收平面的、一對(duì)一的參數(shù)。像上文中這種數(shù)據(jù)結(jié)構(gòu)的參數(shù)，就需要我們?cè)趈ava服務(wù)端定義兩個(gè)類，一個(gè)類是ParamData，一個(gè)類是BestFriend.

public class ParamData {
    private String name;
    private int id;
    private String phone;
    private BestFriend bestFriend;
    public static class BestFriend {
        private String address;
        private String sex;
    }
}

• 注意上面代碼中省略了GET、SET方法等必要的java plain model元素。
• 注意成員變量名稱一定要和JSON屬性名稱對(duì)應(yīng)上。
• 注意接收不同類型的參數(shù)，使用不同的成員變量類型

完成以上動(dòng)作，我們就可以使用@RequestBody ParamData paramData，一次性的接收以上所有的復(fù)雜嵌套對(duì)象參數(shù)了，參數(shù)對(duì)象的所有屬性都將被賦值。

三、Http數(shù)據(jù)轉(zhuǎn)換的原理

大家現(xiàn)在使用JSON都比較普遍了，其方便易用、表達(dá)能力強(qiáng)，是絕大部分?jǐn)?shù)據(jù)接口式應(yīng)用的首選。那么如何響應(yīng)其他的類型的數(shù)據(jù)？其中的判別原理又是什么？下面就來(lái)給大家介紹一下：

• 當(dāng)一個(gè)HTTP請(qǐng)求到達(dá)時(shí)是一個(gè)InputStream，通過(guò)HttpMessageConverter轉(zhuǎn)換為java對(duì)象，從而進(jìn)行參數(shù)接收。
• 當(dāng)對(duì)一個(gè)HTTP請(qǐng)求進(jìn)行響應(yīng)時(shí)，我們首先輸出的是一個(gè)java對(duì)象，然后由HttpMessageConverter轉(zhuǎn)換為OutputStream輸出。

當(dāng)我們?cè)赟pring Boot應(yīng)用中集成了jackson的類庫(kù)之后，如下的一些HttpMessageConverter將會(huì)被加載。

根據(jù)HTTP協(xié)議的Accept和Content-Type屬性，以及參數(shù)數(shù)據(jù)類型來(lái)判別使用哪一種HttpMessageConverter。當(dāng)使用RequestBody或ResponseBody時(shí)，再結(jié)合前端發(fā)送的Accept數(shù)據(jù)類型，會(huì)自動(dòng)判定優(yōu)先使用MappingJacksonHttpMessageConverter作為數(shù)據(jù)轉(zhuǎn)換器。但是，不僅JSON可以表達(dá)對(duì)象數(shù)據(jù)類型，XML也可以。如果我們希望使用XML格式該怎么告知Spring呢，那就要使用到produces屬性了。

@GetMapping(value ="/demo",produces = MediaType.APPLICATION_XML_VALUE)

這里我們明確的告知了返回的數(shù)據(jù)類型是xml，就會(huì)使用Jaxb2RootElementHttpMessageConverter作為默認(rèn)的數(shù)據(jù)轉(zhuǎn)換器。當(dāng)然實(shí)現(xiàn)XML數(shù)據(jù)響應(yīng)比JSON還會(huì)更復(fù)雜一些，還需要結(jié)合@XmlRootElement、@XmlElement等注解實(shí)體類來(lái)使用。同理consumes屬性你是不是也會(huì)用了呢。

四、自定義HttpMessageConverter

其實(shí)絕大多數(shù)的數(shù)據(jù)格式都不需要我們自定義HttpMessageConverter，都有第三方類庫(kù)可以幫助我們實(shí)現(xiàn)(包括下文代碼中的Excel格式)。但有的時(shí)候，有些數(shù)據(jù)的輸出格式并沒(méi)有類似于Jackson這種類庫(kù)幫助我們處理，需要我們自定義數(shù)據(jù)格式。該怎么做?

下面我們就以Excel數(shù)據(jù)格式為例，寫一個(gè)自定義的HTTP類型轉(zhuǎn)換器。實(shí)現(xiàn)的效果就是，當(dāng)我們返回AjaxResponse這種數(shù)據(jù)類型的話，就自動(dòng)將AjaxResponse轉(zhuǎn)成Excel數(shù)據(jù)響應(yīng)給客戶端。

<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;
    }
    //針對(duì)AjaxResponse類型返回值，使用下面的writeInternal方法進(jìn)行消息類型轉(zhuǎn)換
    @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());
    }
}

• 實(shí)現(xiàn)AbstractHttpMessageConverter接口
• 指定該轉(zhuǎn)換器是針對(duì)哪種數(shù)據(jù)格式的？如上文代碼中的"application/vnd.ms-excel"
• 指定該轉(zhuǎn)換器針對(duì)那些對(duì)象數(shù)據(jù)類型？如上文代碼中的supports函數(shù)
• 使用writeInternal對(duì)數(shù)據(jù)進(jìn)行輸出處理，上例中是輸出為Excel格式。

以上就是Spring常用注解及http數(shù)據(jù)轉(zhuǎn)換教程的詳細(xì)內(nèi)容，更多關(guān)于Spring注解及http數(shù)據(jù)轉(zhuǎn)換的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論