spring boot整合mongo查询converter异常排查记录

针对您提出的问题，我会提供一个完整的攻略。

首先，我们需要了解什么是spring boot，以及使用spring boot整合MongoDB时可能会遇到的问题。

什么是Spring Boot

Spring Boot是Spring家族的项目之一，是为了简化Spring应用的搭建和开发而生的。Spring Boot可以说是Spring的一个增强版，通过提供一系列的自动配置和约定优于配置的方式，让开发者可以更快地搭建出高效、稳定、可靠的应用程序，在免去了繁琐的配置过程的同时，还保留了Spring的强大功能。目前，Spring Boot的最新版本是2.5.3。

Spring Boot整合MongoDB

当使用Spring Boot整合MongoDB时，我们需要借助spring-boot-starter-data-mongodb这个依赖。在引入这个依赖后，我们只需要将MongoDB的配置写在application.yml或application.properties里面即可完成基本的整合工作。这样的整合方式可以大大简化我们的开发工作。

但是，当我们尝试使用MongoDB的某些高级功能时，比如自定义converter，就会出现一些问题。这时候，我们需要进行排查，解决问题。

排查异常

在使用converter时，可能会出现很多错误。下面，我将介绍几种常见的错误，并提供解决方案。

ConverterNotFoundException

当你尝试使用自定义converter时，可能会出现ConverterNotFoundException的错误。这通常是因为Spring在初始化MongoDB的MappingMongoConverter时，无法找到你定义的converter。可能的原因包括：

1. converter没被Spring扫描到——我们可以通过@ComponentScan或@Import将converter注入到Spring的bean容器中。
2. MongoMappingContext无法访问到mongoTemplate——我们可以通过配置MongoDbFactory解决。
3. mappingMongoConverter.setCustomConversions方法没有被正确初始化——我们可以通过@PostConstruct注解来标注初始化方法，确保mappingMongoConverter.setCustomConversions在初始化时被正确调用。

解决方法如下：

@Configuration
public class MongoDBConfig {

    private static final String DATABASE = "example_db";

    @Bean
    public MongoClient mongoClient() {
        return MongoClients.create();
    }

    @Bean
    public MongoDbFactory mongoDbFactory(MongoClient mongoClient) {
        return new SimpleMongoClientDbFactory(mongoClient, DATABASE);
    }

    @Bean
    public MongoTemplate mongoTemplate(MongoDbFactory mongoDbFactory) {
        MappingMongoConverter converter = new MappingMongoConverter(new DefaultDbRefResolver(mongoDbFactory), new MongoMappingContext());
        converter.setCustomConversions(new ExampleConversions());
        converter.afterPropertiesSet();
        return new MongoTemplate(mongoDbFactory, converter);
    }

}

ConverterConfigurationException

ConverterConfigurationException通常是由于converter中的某个方法有问题导致的。具体来说，可能存在以下原因导致ConverterConfigurationException：

1. converter.fromDocument和converter.toDocument方法的返回类型不匹配。
2. converter.fromDocument和converter.toDocument的参数类型不正确。
3. converter.fromDocument和converter.toDocument没有正确覆盖相应的超类方法。

解决方法如下：

public class ExampleStringConverter implements Converter<String, Example> {

    @Override
    public Example convert(String source) {
        //先判断source是否是null

        //对source做复杂的转换逻辑

        //返回转换后的Example对象
        return new Example();
    }

}

SpELParseException

SpELParseException可能是因为在converter中使用了错误的SpEL表达式导致的。常见的错误包括：

1. 拼写错误。
2. 少了一个#。
3. 使用了无法解析的字段或方法。
4. 「文本中包含了@符号」导致SpEL表达式无法解析。
5. 错误地使用了单引号和双引号。

解决方法如下：

public class ExampleSpELConverter implements Converter<DBObject, Example> {

    private static final String EXAMPLE_ID_FIELD = "exampleId";
    private static final String EXAMPLE_NAME_FIELD = "exampleName";
    private static final String EXAMPLE_COUNT_FIELD = "exampleCount";

    @Override
    public Example convert(DBObject source) {
        return Example.builder()
                .exampleId((Integer) source.get(EXAMPLE_ID_FIELD))
                .exampleName((String) source.get(EXAMPLE_NAME_FIELD))
                .exampleCount((Integer) source.get(EXAMPLE_COUNT_FIELD))
                .build();
    }

}

示例说明

下面，我将提供两个具体的示例，以帮助您更好地理解上述代码。

示例一

问题：在使用Spring Boot整合MongoDB时，我定义了一个自定义的converter，但是这个converter一直没有被执行。我该如何排查？

答案：

这种情况可能是因为converter没有被正确的初始化。一种解决方法是，我们在MongoDBConfig中，显式初始化MappingMongoConverter并手动注入到mongoTemplate中。代码如下：

@Configuration
public class MongoDBConfig {

    private static final String DATABASE = "example_db";

    @Bean
    public MongoClient mongoClient() {
        return MongoClients.create();
    }

    @Bean
    public MongoDbFactory mongoDbFactory(MongoClient mongoClient) {
        return new SimpleMongoClientDbFactory(mongoClient, DATABASE);
    }

    @Bean
    public MongoTemplate mongoTemplate(MongoDbFactory mongoDbFactory) {
        MappingMongoConverter converter = new MappingMongoConverter(new DefaultDbRefResolver(mongoDbFactory), new MongoMappingContext());
        converter.setCustomConversions(new ExampleConversions());
        converter.afterPropertiesSet();
        return new MongoTemplate(mongoDbFactory, converter);
    }

}

示例二

问题：我在自定义converter时使用了一个错误的SpEL表达式，导致出现了SpELParseException的异常。我该如何解决？

答案：

这种情况可能是因为SpEL表达式使用错误。我们需要检查这个SpEL表达式，确认其是否有拼写错误、是否少了一个#、是否使用了无法解析的字段或方法等问题。例如下面的例子：

public class ExampleSpELConverter implements Converter<DBObject, Example> {

    private static final String EXAMPLE_ID_FIELD = "exampleId";
    private static final String EXAMPLE_NAME_FIELD = "exampleName";
    private static final String EXAMPLE_COUNT_FIELD = "exampleCount";

    @Override
    public Example convert(DBObject source) {
        return Example.builder()
                .exampleId((Integer) source.get(EXAMPLE_ID_FIELD))
                .exampleName(source.toString())
                .exampleCount(Tiime.valueOf(source.get(EXAMPLE_COUNT_FIELD)))
                .build();
    }

}

在这个例子中，我们使用了一个错误的SpEL表达式：source.toString()。这会导致SpEL无法正确解析，从而出现SpELParseException的异常。正确的表达式应该是.exampleName((String)source.get(EXAMPLE_NAME_FIELD))。我们需要把这个错误的表达式修改掉，然后重试。