快捷導(dǎo)航

使用ResponseEntity處理API返回問(wèn)題

更新時(shí)間：2024年07月10日 16:24:40 作者：半城風(fēng)花半城雨

這篇文章主要介紹了使用ResponseEntity處理API返回問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

眾所周知，我們的HTTP/HTTPS的響應(yīng)由狀態(tài)碼、頭部信息以及響應(yīng)體內(nèi)容三大塊組成，響應(yīng)體內(nèi)容可以通過(guò)返回值進(jìn)行一系列封裝回傳出結(jié)果，而狀態(tài)碼與頭部信息需要特別設(shè)置。

ResponseEntity的使用

先上源碼，看看ResponseEntity到底如何使用的。

1. ResponseEntity的第一種使用方式

public class ResponseEntity<T> extends HttpEntity<T> {
    public ResponseEntity(HttpStatus status) {
	    this((Object)null, (MultiValueMap)null, (HttpStatus)status);
	}
	
   public ResponseEntity(@Nullable T body, HttpStatus status) {
        this(body, (MultiValueMap)null, (HttpStatus)status);
    }
	
   public ResponseEntity(MultiValueMap<String, String> headers, HttpStatus status) {
        this((Object)null, headers, (HttpStatus)status);
    }
	
   public ResponseEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers, HttpStatus status) {
        super(body, headers);
        Assert.notNull(status, "HttpStatus must not be null");
        this.status = status;
    }

   private ResponseEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers, Object status) {
        super(body, headers);
        Assert.notNull(status, "HttpStatus must not be null");
        this.status = status;
    }
}

可以看到這個(gè)類(lèi)提供了五個(gè)構(gòu)造方法，返回的狀態(tài)碼是必傳的外，頭部信息以及響應(yīng)體內(nèi)容都是可選擇的。

當(dāng)我們需要使用的時(shí)候，直接new一個(gè)ResponseEntity對(duì)象作為API返回值即可，這就是它的第一種使用方式。

需要注意的是，在有headers作為參數(shù)的構(gòu)造方法中，需要傳入一個(gè)類(lèi)型為MultiValueMap<String, String>的參數(shù)。

MultiValueMap繼承自Map這個(gè)抽象類(lèi)，其中擁有一個(gè)叫做HttpHeaders的子類(lèi)，我們可以當(dāng)它為一個(gè)key和value都為String類(lèi)型的HashMap使用。

HttpHeaders里面保存了一些常用的Header的key值，例如"Accept-Charset"。當(dāng)然也可以自定義一些特殊的key。

HttpHeaders headers = new HttpHeaders();
headers.add("Access-Control-Expose-Headers", "AMP-Access-Control-Allow-Source-Origin");

return new ResponseEntity<>(resultBody, headers, HttpStatus.OK);

2. ResponseEntity的第二種使用方式

繼續(xù)看源碼，發(fā)現(xiàn)了好多返回值為ResponseEntity.BodyBuilder的方法有木有

    public static ResponseEntity.BodyBuilder status(HttpStatus status) {
        Assert.notNull(status, "HttpStatus must not be null");
        return new ResponseEntity.DefaultBuilder(status);
    }

    public static ResponseEntity.BodyBuilder status(int status) {
        return new ResponseEntity.DefaultBuilder(status);
    }
        public static ResponseEntity.BodyBuilder ok() {
        return status(HttpStatus.OK);
    }
    public static ResponseEntity.BodyBuilder created(URI location) {
        ResponseEntity.BodyBuilder builder = status(HttpStatus.CREATED);
        return (ResponseEntity.BodyBuilder)builder.location(location);
    }

    public static ResponseEntity.BodyBuilder accepted() {
        return status(HttpStatus.ACCEPTED);
    }

    public static ResponseEntity.HeadersBuilder<?> noContent() {
        return status(HttpStatus.NO_CONTENT);
    }

    public static ResponseEntity.BodyBuilder badRequest() {
        return status(HttpStatus.BAD_REQUEST);
    }

    public static ResponseEntity.HeadersBuilder<?> notFound() {
        return status(HttpStatus.NOT_FOUND);
    }

    public static ResponseEntity.BodyBuilder unprocessableEntity() {
        return status(HttpStatus.UNPROCESSABLE_ENTITY);
    }
    .........

事實(shí)證明，越是偉大的軟件工程師是越“懶惰”的，為了節(jié)約時(shí)間增加效率，我們可以用Builder的方式去生成ResponseEntity對(duì)象并返回：

Map<String, String> resultBody = new HashMap<>();
resultBody.put("name":"Lucas");
resultBody.put("school":"harvard university");
 return ResponseEntity.status(HttpStatus.OK)
        .body(resultBody);

與其他方式對(duì)比

@RestController注解修飾controller層。

@RestController = @Controller + @ResponseBody

@ResponseBody是將controller的方法返回的對(duì)象通過(guò)適當(dāng)?shù)霓D(zhuǎn)換器轉(zhuǎn)換為指定的格式之后，寫(xiě)入到response對(duì)象的body區(qū)，通常用來(lái)返回JSON數(shù)據(jù)或者是XML數(shù)據(jù)。

注意：在使用此注解之后不會(huì)再走視圖處理器（ModelAndView），而是直接將數(shù)據(jù)寫(xiě)入到輸入流中，他的效果等同于通過(guò)response對(duì)象輸出指定格式的數(shù)據(jù)。

@ResponseStatus

這個(gè)注解主要用在自定義的Exception 上，或者直接用在controller層的API方法上也可，當(dāng)發(fā)生異常/方法執(zhí)行結(jié)束時(shí)，會(huì)返回相應(yīng)的Http狀態(tài)碼和msg。

@ResponseStatus(value=HttpStatus.FORBIDDEN,reason="不允許訪問(wèn)")

注：

ResponseEntity的優(yōu)先級(jí)高于@ResponseBody。
只有在返回值不為ResponseEntity的情況下才去檢查有沒(méi)有@ResponseBody注解；如果響應(yīng)類(lèi)型是ResponseEntity則會(huì)忽略@ResponseBody注解。