SpringBoot?MongoCustomConversions自定義轉換方式

更新時間：2023年08月11日 09:32:05 作者：_蓄圓

這篇文章主要介紹了SpringBoot?MongoCustomConversions自定義轉換方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

SpringBoot MongoCustomConversions自定義轉換

主要講述如何將mongo查詢語句出來的東西轉換成某個modelMongoTemplate.find(new BasicQuery(obj),XXX.class)

添加配置類

重新定義一下 MongoTemplate

import java.util.ArrayList;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.convert.converter.Converter;
import org.springframework.data.mongodb.MongoDbFactory;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.convert.MappingMongoConverter;
import org.springframework.data.mongodb.core.convert.MongoCustomConversions;
// 該類的目的是把自定義編寫的轉換類 注入 MongoTemplate 中
@Configuration
public class MongoConfig{
	@Autowired
	MongoDbFactory factory;
	@Bean //注冊客制化轉換 添加自定義轉換類(樓主以TestConverter為列，具體編寫跳轉“編寫自定義轉換類”)
	public MongoCustomConversions customConversions() {
		List<Converter<?,?>> converters = new ArrayList<Converter<?,?>>();
		converters.add(new TestConverter());
		return new MongoCustomConversions(converters);
	}
	@Bean 
	public MongoTemplate mongoTemplate() throws Exception { 
	    MongoTemplate mongoTemplate = new MongoTemplate(factory); 
	    MappingMongoConverter mongoMapping = (MappingMongoConverter) mongoTemplate.getConverter(); 
	    mongoMapping.setCustomConversions(customConversions()); // tell mongodb to use the custom converters 
	    mongoMapping.afterPropertiesSet(); 
	    return mongoTemplate; 
	} 
}

編寫自定義轉換類

import org.bson.Document;
import org.springframework.core.convert.converter.Converter;
public class TestConverter implements Converter<Document, MaxtqReport> {
	/**
	 * @param source : mongo中查詢出的內容
	 * @return Test : 我們需要轉換的目標類
	 */
	@Override
	public Test convert(Document source) {
		Test result = new Test();
		result.setId(source.getObjectId("_id").toString());
		result.setContent(content);
		//自定義 code...
		return result;
	}
}

業(yè)務流程的代碼塊

@Autowired // MongoTemplate 的創(chuàng)建用自動注入
MongoTemplate template;
// 這里主要是介紹一下 業(yè)務流程中如何使用
// 這里是一個按手機號查詢案例
public void test(String mobile){
	BasicDBList basicDBList = new BasicDBList();
	if (StringUtils.isNotBlank(mobile)) {	
		// 添加查詢參數(shù)
		basicDBList.add(new BasicDBObject("mobile", param.mobile));
	}
	Document obj = new Document();
	obj.put("$and", basicDBList);
	//創(chuàng)建查詢對象
	Query query = new BasicQuery(obj);
	// 此處會調用我們自定義的轉換
	List<Test> test = this.template.find(query, Test.class) 
}

SpringBoot 自定義轉換器

基本介紹

SpringBoot 在響應客戶端請求時，將提交的數(shù)據(jù)封裝成對象時，使用了內置的轉換器

SpringBoot 也支持自定義轉換器, 這個內置轉換器在 debug 的時候, 可以看到, 提供了 124 個內置轉換器. 看下源碼 GenericConverter-ConvertiblePair

自定義類型轉換器—應用實例

1.需求說明 : 演示自定義轉換器使用

2.代碼實現(xiàn)

1.修改src\main\resources\static\save.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>添加妖怪</title></head>
<body><h1>添加妖怪-坐騎[測試封裝 POJO；]</h1>
<form action="/savemonster" method="post">
    編號： <input name="id" value="100"><br/>
    姓名： <input name="name" value="牛魔王"/><br/>
    年齡： <input name="age" value="120"/> <br/>
    婚否： <input name="isMarried" value="true"/> <br/>
    生日： <input name="birth" value="2000/11/11"/> <br/>
    <!-- 使用自定義轉換器關聯(lián)car, 字符串整體提交, 使用,號間隔  -->
    坐騎：<input name="car" value="避水金晶獸,666.6"><br/>
    <input type="submit" value="保存"/>
</form>
</body>
</html>

2.修改src\main\java\com\llp\springboot\controller\ParameterController.java

@PostMapping("/savemonster")
public String saveMonster(Monster monster) {
    //monster= Monster(id=100, name=牛魔王, age=120, isMarried=true, birth=Sat Nov 11 00:00:00 CST 2000, car=Car(name=避水金晶獸, price=666.6))
    System.out.println("monster= " + monster);
    return "success";
}

3.自定義一個類型轉換器src\main\java\com\llp\springboot\config\WebConfig.java

/**
 * 開啟lite模式,通過容器獲取bean時將是多例的
 */
@Configuration(proxyBeanMethods = false)
public class WebConfig {
    @Bean
    public WebMvcConfigurer webMvcConfigurer() {
        return new WebMvcConfigurer() {
            @Override
            public void addFormatters(FormatterRegistry registry) {
                /**
                 * 1. 在addFormatters 方法中,增加一個自定義的轉換器
                 * 2. 增加自定義轉換器 String -> Car
                 * 3. 增加的自定義轉換器會注冊到 converters 容器中
                 * 4. converters 底層結構是 ConcurrentHashMap 內置有124轉換器
                 */
                registry.addConverter(new Converter<String, Car>() {
                    @Override
                    public Car convert(String content) {
                        if (!ObjectUtils.isEmpty(content)) {
                            //避水金晶獸,666.6
                            String[] split = content.split(",");
                            String name = split[0];
                            double price = Double.parseDouble(split[1]);
                            return new Car(name, price);
                        }
                        return null;
                    }
                });
            }
        };
    }
}

注意事項及使用細節(jié)

1.我們可以定義多個自定義轉換器

/**
 * 開啟lite模式,通過容器獲取bean時將是多例的
 */
@Configuration(proxyBeanMethods = false)
public class WebConfig {
    @Bean
    public WebMvcConfigurer webMvcConfigurer() {
        return new WebMvcConfigurer() {
            @Override
            public void addFormatters(FormatterRegistry registry) {
                Converter<String, Car> carConverter1 = new Converter<String, Car>() {
                    @Override
                    public Car convert(String content) {
                        if (!ObjectUtils.isEmpty(content)) {
                            //避水金晶獸,666.6
                            String[] split = content.split(",");
                            String name = split[0];
                            double price = Double.parseDouble(split[1]);
                            return new Car(name, price);
                        }
                        return null;
                    }
                };
                Converter<String, Monster> monsterConverter = new Converter<String, Monster>() {
                    @Override
                    public Monster convert(String s) {
                        return null;
                    }
                };
                Converter<String, Car> carConverter2 = new Converter<String, Car>() {
                    @Override
                    public Car convert(String s) {
                        System.out.println(s);
                        return null;
                    }
                };
                registry.addConverter(carConverter1);
                //carConverter1、carConverter2的key均為 java.lang.String->com.llp.springboot.bean.Car組成
                //因此carConverter2會覆蓋掉carConverter1
                registry.addConverter(carConverter2);
                registry.addConverter(monsterConverter);
            }
        };
    }
}

2.底層在定義了一變量名為convertes的ConCurrentHashMap用于存儲所有的類型轉換器，而key是由“原類型->目標類型”構成的，因此當自定義的key相同時會覆蓋調之前的類型轉換器，這里我們定義了三個自定義轉換器但其中兩個時相同的key因此只會保留最后一次添加的類型轉換器