Spring-Boot项目中如何定制PropertyEditors

本文首发于个人网站：Spring Boot 项目中如何定制 PropertyEditors

在 Spring Boot: 定制 HTTP 消息转换器一文中我们学习了如何配置消息转换器用于 HTTP 请求和响应数据，实际上，在一次请求的完成过程中还发生了其他的转换，我们这次关注将参数转换成多种类型的对象，如：字符串转换成 Date 对象或字符串转换成 Integer 对象。

在编写控制器中的 action 方法时，Spring 允许我们使用具体的数据类型定义函数签名，这是通过 PropertyEditor 实现的。PropertyEditor本来是 JDK 提供的 API，用于将文本值转换成给定的类型，结果 Spring 的开发人员发现它恰好满足 Spring 的需求——将 URL 参数转换成函数的参数类型。

针对常用的类型（Boolean、Currency 和 Class），Spring MVC 已经提供了很多 PropertyEditor 实现。假设我们需要创建一个 Isbn 类并用它作为函数中的参数。

实战

• 考虑到 PropertyEditor 属于工具范畴，选择在项目根目录下增加一个包——utils。在这个包下定义 Isbn 类和 IsbnEditor 类，各自代码如下：
  Isbn 类：

package com.test.bookpub.utils;

public class Isbn {
    private String isbn;

    public Isbn(String isbn) {this.isbn = isbn;}
    public String getIsbn() {return isbn;}
}

• IsbnEditor 类，继承 PropertyEditorSupport 类，setAsText 完成字符串到具体对象类型的转换，getAsText 完成具体对象类型到字符串的转换。

package com.test.bookpub.utils;
import org.springframework.util.StringUtils;
import java.beans.PropertyEditorSupport;

public class IsbnEditor extends PropertyEditorSupport {
    @Override
    public void setAsText(String text) throws IllegalArgumentException {if (StringUtils.hasText(text)) {setValue(new Isbn(text.trim()));
        } else {setValue(null);
        }
    }
    @Override    public String getAsText() {Isbn isbn = (Isbn) getValue();
        if (isbn != null) {return isbn.getIsbn();
        } else {return "";}
    }
}

• 在 BookController 中增加 initBinder 函数，通过 @InitBinder 注解修饰，则可以针对每个 web 请求创建一个 editor 实例。

@InitBinderpublic 
void initBinder(WebDataBinder binder) {binder.registerCustomEditor(Isbn.class, new IsbnEditor());
}

• 修改 BookController 中对应的函数

@RequestMapping(value = "/{isbn}", method = RequestMethod.GET)
public Map<String, Object> getBook(@PathVariable Isbn isbn) {Book book =  bookRepository.findBookByIsbn(isbn.getIsbn());
    Map<String, Object> response = new LinkedHashMap<>();
    response.put("message", "get book with isbn(" + isbn.getIsbn() +")");
    response.put("book", book);    return response;
}

运行程序，通过 Httpie 访问http localhost:8080/books/9781-1234-1111，可以得到正常结果，跟之前用 String 表示 isbn 时没什么不同，说明我们编写的 IsbnEditor 已经起作用了。

分析

Spring 提供了很多默认的 editor，我们也可以通过继承 PropertyEditorSupport 实现自己定制化的 editor。

由于 ProperteyEditor 是 非线程安全 的。通过 @InitBinder 注解修饰的 initBinder 函数，会为每个 web 请求初始化一个 editor 实例，并通过 WebDataBinder 对象注册。

Spring Boot 1.x 系列

1. Spring Boot 的自动配置、Command-line-Runner
2. 了解 Spring Boot 的自动配置
3. Spring Boot 的 @PropertySource 注解在整合 Redis 中的使用
4. Spring Boot 项目中如何定制 HTTP 消息转换器
5. Spring Boot 整合 Mongodb 提供 Restful 接口
6. Spring 中 bean 的 scope
7. Spring Boot 项目中使用事件派发器模式
8. Spring Boot 提供 RESTful 接口时的错误处理实践
9. Spring Boot 实战之定制自己的 starter
10. Spring Boot 项目如何同时支持 HTTP 和 HTTPS 协议
11. 自定义的 Spring Boot starter 如何设置自动配置注解
12. Spring Boot 项目中使用 Mockito
13. 在 Spring Boot 项目中使用 Spock 测试框架

本号专注于后端技术、JVM 问题排查和优化、Java 面试题、个人成长和自我管理等主题，为读者提供一线开发者的工作和成长经验，期待你能在这里有所收获。