首页 > 软件编程 > java > SpringBoot MongoCustomConversions自定义转换

SpringBoot MongoCustomConversions自定义转换方式

2023-08-11 09:28:41 作者：_蓄圆

这篇文章主要介绍了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;
	}
}

业务流程的代码块

@Autowired // MongoTemplate 的创建用自动注入
MongoTemplate template;
// 这里主要是介绍一下 业务流程中如何使用
// 这里是一个按手机号查询案例
public void test(String mobile){
	BasicDBList basicDBList = new BasicDBList();
	if (StringUtils.isNotBlank(mobile)) {	
		// 添加查询参数
		basicDBList.add(new BasicDBObject("mobile", param.mobile));
	}
	Document obj = new Document();
	obj.put("$and", basicDBList);
	//创建查询对象
	Query query = new BasicQuery(obj);
	// 此处会调用我们自定义的转换
	List<Test> test = this.template.find(query, Test.class) 
}

SpringBoot 自定义转换器

基本介绍

SpringBoot 在响应客户端请求时，将提交的数据封装成对象时，使用了内置的转换器

SpringBoot 也支持自定义转换器, 这个内置转换器在 debug 的时候, 可以看到, 提供了 124 个内置转换器. 看下源码 GenericConverter-ConvertiblePair

自定义类型转换器—应用实例

1.需求说明 : 演示自定义转换器使用

2.代码实现

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/>
    <!-- 使用自定义转换器关联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;
                    }
                });
            }
        };
    }
}

注意事项及使用细节

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因此只会保留最后一次添加的类型转换器

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

SpringBoot MongoCustomConversions自定义转换方式