淺談讓@Value更方便的Spring自定義轉(zhuǎn)換類

更新時(shí)間：2021年06月22日 15:39:29 作者：南瓜慢說

Spring為大家內(nèi)置了不少開箱即用的轉(zhuǎn)換類，如字符串轉(zhuǎn)數(shù)字、字符串轉(zhuǎn)時(shí)間等，但有時(shí)候需要使用自定義的屬性，則需要自定義轉(zhuǎn)換類了

一、萬能的字符串

當(dāng)然，任何時(shí)候都可以使用字符串作為屬性的值，從配置文件里讀取出來，如下：

配置文件內(nèi)容為：

pkslow.admin=larry|18|admin@pkslow.com

通過|分割，分別是名字、年齡和郵箱。

對應(yīng)屬性為：

@Value("${pkslow.admin}")
private String admin;

使用字符串，總是可以獲取，并且不會(huì)報(bào)錯(cuò)。我們可以在使用屬性的時(shí)候，再轉(zhuǎn)換成其它Bean。

但這樣做有一些問題：

無法做配置檢驗(yàn)，不管是否配置錯(cuò)誤，String類型的屬性都是可以讀取的；
任何地方使用，都需要做顯式轉(zhuǎn)換。

二、自定義轉(zhuǎn)換類

使用自定義轉(zhuǎn)換類是更方便和安全的做法。我們來看看怎么實(shí)現(xiàn)。

先定義一個(gè)Java Bean，用以表示實(shí)際的配置內(nèi)容：

package com.pkslow.cloud.rest.model;

public class Admin {
    private String name;
    private Integer age;
    private String email;

    public Admin(String name, Integer age, String email) {
        this.name = name;
        this.age = age;
        this.email = email;
    }
  //getter and setter
}

接著肯定需要一個(gè)轉(zhuǎn)換類，需要實(shí)現(xiàn)Converter接口：

package com.pkslow.cloud.rest.model;

import org.springframework.core.convert.converter.Converter;

public class AdminConverter implements Converter<String, Admin> {
    @Override
    public Admin convert(String s) {
        String[] strings = s.split("\\|");
        return new Admin(strings[0], Integer.parseInt(strings[1]), strings[2]);
    }
}

這個(gè)轉(zhuǎn)換類就是轉(zhuǎn)換邏輯，如果把字符串轉(zhuǎn)換成對應(yīng)的類。

完成以上兩步，關(guān)鍵是如果告訴Spring我具備了這個(gè)轉(zhuǎn)換能力，并幫我轉(zhuǎn)換。需要把轉(zhuǎn)換類綁定一下：

package com.pkslow.cloud.rest.config;

import com.pkslow.cloud.rest.model.AdminConverter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.ConversionServiceFactoryBean;

import java.util.Collections;

@Configuration
public class AdminConversionServiceConfig {
    @Bean
    public ConversionServiceFactoryBean conversionService() {
        ConversionServiceFactoryBean factoryBean = new ConversionServiceFactoryBean();
        factoryBean.setConverters(Collections.singleton(new AdminConverter()));
        return factoryBean;
    }
}

有了以上功能，使用就非常簡單了。配置不變，使用如下：

package com.pkslow.cloud.rest;

import com.pkslow.cloud.rest.model.Admin;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class PkslowController {

    @Value("${pkslow.admin}")
    private Admin adminBean;

    @GetMapping("/getAdminBean")
    public Admin getAdminBean() {
        return adminBean;
    }
}

屬性的類型為Admin，是一個(gè)自定義的類。啟動(dòng)訪問后獲取如下：

$ curl localhost:8081/getAdminBean

{"name":"larry","age":18,"email":"admin@pkslow.com"}

說明成功讀取了配置，并轉(zhuǎn)換成我們想要的domain Object。

嘗試把配置改為：pkslow.admin=larry|18a|admin@pkslow.com，則啟動(dòng)時(shí)會(huì)報(bào)錯(cuò)：

Caused by: org.springframework.core.convert.ConversionFailedException:

Failed to convert from type [java.lang.String] to type [@org.springframework.beans.factory.annotation.Value com.pkslow.cloud.rest.model.Admin]

for value 'larry|18a|admin@pkslow.com';

nested exception is java.lang.NumberFormatException: For input string: "18a"

可以做配置檢查。