快捷導(dǎo)航

Spring Boot定制type Formatters實(shí)例詳解

更新時(shí)間：2019年11月10日 09:11:54 作者：javaadu

在本篇文章里小編給大家整理的是關(guān)于Spring Boot定制type Formatters實(shí)例知識(shí)點(diǎn)，需要的朋友們學(xué)習(xí)下。

前面我們有篇文章介紹了PropertyEditors，是用來(lái)將文本類(lèi)型轉(zhuǎn)換成指定的Java類(lèi)型，不過(guò)，考慮到PropertyEditor的無(wú)狀態(tài)和非線程安全特性，Spring 3增加了一個(gè)Formatter接口來(lái)替代它。Formatters提供和PropertyEditor類(lèi)似的功能，但是提供線程安全特性，也可以實(shí)現(xiàn)字符串和對(duì)象類(lèi)型的互相轉(zhuǎn)換。

假設(shè)在我們的程序中，需要根據(jù)一本書(shū)的ISBN字符串得到對(duì)應(yīng)的book對(duì)象。通過(guò)這個(gè)類(lèi)型格式化工具，我們可以在控制器的方法簽名中定義Book參數(shù)，而URL參數(shù)只需要包含ISBN號(hào)和數(shù)據(jù)庫(kù)ID。

實(shí)戰(zhàn)

首先在項(xiàng)目根目錄下創(chuàng)建formatters包
然后創(chuàng)建BookFormatter，它實(shí)現(xiàn)了Formatter接口，實(shí)現(xiàn)兩個(gè)函數(shù)：parse用于將字符串ISBN轉(zhuǎn)換成book對(duì)象；print用于將book對(duì)象轉(zhuǎn)換成該book對(duì)應(yīng)的ISBN字符串。

package com.test.bookpub.formatters;

import com.test.bookpub.domain.Book;
import com.test.bookpub.repository.BookRepository;
import org.springframework.format.Formatter;
import java.text.ParseException;
import java.util.Locale;

public class BookFormatter implements Formatter<Book> {
 private BookRepository repository;

 public BookFormatter(BookRepository repository) {
  this.repository = repository;
 }
 
 @Override
 public Book parse(String bookIdentifier, Locale locale) throws ParseException {
  Book book = repository.findBookByIsbn(bookIdentifier);
  return book != null ? book : repository.findOne(Long.valueOf(bookIdentifier));
 }
 
 @Override
 public String print(Book book, Locale locale) {
  return book.getIsbn();
 }
}

在WebConfiguration中添加我們定義的formatter，重寫(xiě)（@Override修飾）addFormatter(FormatterRegistry registry)函數(shù)。

@Autowired
private BookRepository bookRepository;

@Override
public void addFormatters(FormatterRegistry registry) {
 registry.addFormatter(new BookFormatter(bookRepository));
}

最后，需要在BookController中新加一個(gè)函數(shù)getReviewers，根據(jù)一本書(shū)的ISBN號(hào)獲取該書(shū)的審閱人。

@RequestMapping(value = "/{isbn}/reviewers", method = RequestMethod.GET)
public List<Reviewer> getReviewers(@PathVariable("isbn") Book book) {
 return book.getReviewers();
}

通過(guò)mvn spring-boot:run運(yùn)行程序

通過(guò)httpie訪問(wèn)URL——http://localhost:8080/books/9781-1234-1111/reviewers，得到的結(jié)果如下：

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Tue, 08 Dec 2015 08:15:31 GMT
Server: Apache-Coyote/1.1
Transfer-Encoding: chunked

[]

分析

Formatter工具的目標(biāo)是提供跟PropertyEditor類(lèi)似的功能。通過(guò)FormatterRegistry將我們自己的formtter注冊(cè)到系統(tǒng)中，然后Spring會(huì)自動(dòng)完成文本表示的book和book實(shí)體對(duì)象之間的互相轉(zhuǎn)換。由于Formatter是無(wú)狀態(tài)的，因此不需要為每個(gè)請(qǐng)求都執(zhí)行注冊(cè)formatter的動(dòng)作。

使用建議：如果需要通用類(lèi)型的轉(zhuǎn)換——例如String或Boolean，最好使用PropertyEditor完成，因?yàn)檫@種需求可能不是全局需要的，只是某個(gè)Controller的定制功能需求。

我們?cè)赪ebConfiguration中引入（@Autowired）了BookRepository（需要用它創(chuàng)建BookFormatter實(shí)例），Spring給配置文件提供了使用其他bean對(duì)象的能力。Spring本身會(huì)確保BookRepository先創(chuàng)建，然后在WebConfiguration類(lèi)的創(chuàng)建過(guò)程中引入。

以上就是本次介紹的全部相關(guān)知識(shí)點(diǎn)內(nèi)容，感謝大家的學(xué)習(xí)和對(duì)腳本之家的支持。