springboot学习(十四)：MongoDB的使用

素颜马尾好姑娘i 2022-04-23 10:06 204阅读 0赞

# 说明 #

本篇博文主要记录总结在springboot中使用MongoDB，有关spring对MongoDB支持的更多内容详见：[《Spring Data MongoDB - Reference Documentation》][Spring Data MongoDB - Reference Documentation]

# 正文 #

## 1.添加依赖 ##

<dependency>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-data-mongodb</artifactId>
    </dependency>

## 2.配置MongoDB ##

可以通过spring的配置方式，在application.properties文件中通过spring的指定参数配置mongo

spring.data.mongodb.host=127.0.0.1
    spring.data.mongodb.port=27017
    spring.data.mongodb.database=test
    spring.data.mongodb.username=root
    spring.data.mongodb.password=123

也可以通过创建配置文件mongo.properties和配置类来配置MongoDB，通过MongoConn类接收配置参数，通过MongoConfig配置MonogoTemplate

public class MongoConn {
    
        private String url;
        private String port;
        private String userName;
        private String password;
        private String database;
    
        public MongoConn() {
        }
    
        public MongoConn(String url, String port, String userName, String password, String database) {
            this.url = url;
            this.port = port;
            this.userName = userName;
            this.password = password;
            this.database = database;
        }
        //省略setter getter
    }

这里通过MongoTemplate来进行CRUD

@Configuration
    @PropertySource("classpath:mongo.properties")
    public class MongoConfig {
    
        @Bean
        @ConfigurationProperties(prefix = "mongodb")
        public MongoConn mongoConn() {
            return new MongoConn();
        }
    
        @Bean
        public MongoClient mongoClient(@Qualifier("mongoConn") MongoConn mongoConn) {
            MongoCredential mongoCredential = MongoCredential.createCredential(mongoConn.getUserName(), mongoConn.getDatabase(), mongoConn.getPassword().toCharArray());
            ServerAddress serverAddress = new ServerAddress(mongoConn.getUrl(), Integer.parseInt(mongoConn.getPort()));
            return new MongoClient(serverAddress, Arrays.asList(mongoCredential));
        }
        @Bean
        public MongoTemplate mongoTemplate(@Qualifier("mongoClient") MongoClient mongoClient,
                                           @Qualifier("mongoConn") MongoConn mongoConn) {
            return new MongoTemplate(new SimpleMongoDbFactory(mongoClient, mongoConn.getDatabase()));
        }
    }

在通过自定义配置文件，配置类来配置mongo时，需要关闭spring的自动配置，在启动类上添加注解类排除自动配置类

@EnableAutoConfiguration(exclude = {DataSourceAutoConfiguration.class, MongoAutoConfiguration.class, MongoDataAutoConfiguration.class})
    @SpringBootApplication
    public class MongoApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(MongoApplication.class, args);
    	}
    
    }

### 3.MongoDB Repositories ###

除了通过MongoTemplate来操作mongo，还可以通过spring data repositories对MongoDB的支持来操作数据库。

#### 创建实体类（entity） ####

public class User {
    
        private String uid;
        private String uname;
        private Integer age;
    
        public User() {
        }
    
        public User(String uid, String uname, int age) {
            this.uid = uid;
            this.uname = uname;
            this.age = age;
        }
        //省略getter setter
    }

创建UserRepository接口，继承MongoRespository<User,String>

public interface UserRepository extends MongoRepository<User, String> {
    }

### 4.CRUD ###

在上面配置示例中，使用了两种方式，一种是通过spring的自动配置，另一种是通过自定义配置。在使用自定义配置时，创建了MongoTemplate来操作数据库。  
使用MongoTemplate操作数据库时，可以通过Query,Criteria来创建比较复杂的查询语句，还可以自定义MongoConverter来创建数据库表和实体类间的映射关系，默认使用的是MappingMongoConverter。  
简单的使用示例：

@Test
    public void testTemplate() {
        Query query = new Query(new Criteria("uid").is("1001"));
     	List<User> users = mongoTemplate.find(query, User.class, "user");
    	users.forEach(user -> System.out.println(user.getUname()));
    }

在第三部分创建了实体类的repository，通过继承MongoRepository接口来操作数据库中的数据。MongoRepository继承了PagingAndSortingRepository，PagingAndSortingRepository继承了CrudRepository, CrudRepository是最底层的支持类，定义了crud方法。  
Repository代理有两种方式从方法名称得到特定存储的查询方法：

1.  直接从方法名称得到
2.  通过自定义Query

简单的使用示例：

public interface UserRepository extends MongoRepository<User, String> {
    
        User findUserByUname(String uname);
    
        User findUserByAge(Integer age);
    
        User findUserByUidAndAge(String uid, Integer age);
    
        List<User> findUsersByAgeIn(Integer... ages);
    
        //(start, end) 不包含起始位置的值
        List<User> findUsersByUidBetweenOrderByAgeDesc(String startId, String endId);
    
        List<User> findUsersByUnameIn(String... unames);
    
        List<User> findUsersByUidContaining(String uids);
    
        Page<User> findUsersByUidIn(Pageable pageable, String... uids);
    }

以上内容简单介绍了在springboot中如何使用MongoDB，更多详细的内容请查看spring的官方文档。

源码地址：[https://github.com/Edenwds/springboot\_study/tree/master/mongodb][https_github.com_Edenwds_springboot_study_tree_master_mongodb]

[Spring Data MongoDB - Reference Documentation]: https://docs.spring.io/spring-data/mongodb/docs/2.1.4.RELEASE/reference/html/
[https_github.com_Edenwds_springboot_study_tree_master_mongodb]: https://github.com/Edenwds/springboot_study/tree/master/mongodb