MongoDB和Java（5）：Spring Data整合MongoDB（注解配置）

 

最近花了一些时间学习了下MongoDB数据库，感觉还是比较全面系统的，涉及了软件安装、客户端操作、安全认证、副本集和分布式集群搭建，以及使用Spring Data连接MongoDB进行数据操作，收获很大。特此记录，以备查看。

 

文章目录：

MongoDB和Java（1）：Linux下的MongoDB安装

MongoDB和Java（2）：普通用户启动mongod进程

MongoDB和Java（3）：Java操作MongoB

MongoDB和Java（4）：Spring Data整合MongoDB（XML配置）

MongoDB和Java（5）：Spring Data整合MongoDB（注解配置）

MongoDB和Java（6）：Spring Data整合MongoDB副本集、分片集群

MongoDB和Java（7）：MongoDB用户管理

 

本文记录如何使用注解配置方式整合Spring data和MongoDB，基础的环境和使用xml整合是一样的，不同的是：

1）删除spring的xml配置文件

2）不再编写数据层的实现，而是使用Spring Data Mongodb扫描创建代理实现

 

源代码下载
MongoDB和Java学习代码.zip

 

1、MongoProperties类

这个类用于读取mongo.properties中属性

@Component
@PropertySource(value = "classpath:mongodb.properties")
public class MongoProperties {

    @Value("${mongo.host}")
    private String host;

    @Value("${mongo.port}")
    private Integer port;

    @Value("${mongo.dbname}")
    private String dbname;

    @Value("${mongo.username}")
    private String username;

    @Value("${mongo.password}")
    private String password;

    @Value("${mongo.connectionsPerHost}")
    private int connectionsPerHost;

    @Value("${mongo.minConnectionsPerHost}")
    private int minConnectionsPerHost;

    @Value("${mongo.threadsAllowedToBlockForConnectionMultiplier}")
    private int threadsAllowedToBlockForConnectionMultiplier;

    @Value("${mongo.connectTimeout}")
    private int connectTimeout;

    @Value("${mongo.maxWaitTime}")
    private int maxWaitTime;

    @Value("${mongo.socketKeepAlive}")
    private boolean socketKeepAlive;

    @Value("${mongo.socketTimeout}")
    private int socketTimeout;

    // getter & setter
}

 

mongo.properties文件

mongo.host=10.10.13.195
mongo.port=27017

# 数据库和验证信息
mongo.dbname=test
mongo.username=xugf
mongo.password=123456

mongo.connectionsPerHost=8
mongo.minConnectionsPerHost=3
mongo.threadsAllowedToBlockForConnectionMultiplier=4
mongo.connectTimeout=1000
mongo.maxWaitTime=1500
mongo.socketKeepAlive=true
mongo.socketTimeout=1500

 

2、MongoConfiguration配置类

这个类用于配置MongoClient和DbFactory

 

我们参考下官方文档，https://github.com/spring-projects/spring-data-mongodb

 

1）配置类继承AbstractMongoConfiguration

2）使用@EnableMongoRepositories注解开启MongoRepsitory的扫描功能

 

看下这个类的代码

@EnableMongoRepositories(basePackages = "org.net5ijy.mongo.dao")
@Configuration
@ComponentScan(basePackages = { "org.net5ijy.mongo" })
public class MongoConfiguration extends AbstractMongoConfiguration {

    @Autowired
    private MongoProperties mongoProperties;

    public MongoClient mongoClient() throws Exception {

        // 获取单机服务器环境
        ServerAddress address = new ServerAddress(mongoProperties.getHost(),
                mongoProperties.getPort());

        List<MongoCredential> credentialsList = new ArrayList<MongoCredential>();
        credentialsList.add(MongoCredential.createScramSha1Credential(
                mongoProperties.getUsername(), mongoProperties.getDbname(),
                mongoProperties.getPassword().toCharArray()));

        Builder builder = MongoClientOptions.builder();

        builder.connectionsPerHost(mongoProperties.getConnectionsPerHost());
        builder.threadsAllowedToBlockForConnectionMultiplier(mongoProperties
                .getThreadsAllowedToBlockForConnectionMultiplier());
        builder.connectTimeout(mongoProperties.getConnectTimeout());
        builder.maxWaitTime(mongoProperties.getMaxWaitTime());
        builder.socketKeepAlive(mongoProperties.isSocketKeepAlive());
        builder.socketTimeout(mongoProperties.getSocketTimeout());
        builder.minConnectionsPerHost(mongoProperties
                .getMinConnectionsPerHost());

        return new MongoClient(address, credentialsList, builder.build());
    }

    @Bean
    public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() {
        return new PropertySourcesPlaceholderConfigurer();
    }

    @Override
    protected String getDatabaseName() {
        return mongoProperties.getDbname();
    }

    @Override
    public Mongo mongo() throws Exception {
        return mongoClient();
    }
}

 

3、数据层接口

继承MongoRepository

public interface EmployeeDao extends MongoRepository<Employee, String> {

    void deleteByName(String name);

    Employee findByName(String name);
}

 

4、JUnit测试代码

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = { MongoConfiguration.class })
public class EmployeeDaoTest {

    @Autowired
    private EmployeeDao employeeDao;

    @Autowired
    private ConfigurableApplicationContext context;

    @Test
    public void testFindAll() throws Exception {

        System.out.println("\n##### ApplicationContext class #####\n");

        System.out.println(context.getClass());

        System.out.println("\n##### Object names #####\n");

        String[] names = context.getBeanDefinitionNames();
        for (String name : names) {
            System.out.println(name);
        }

        System.out.println("\n##### MongoDB employees #####\n");

        List<Employee> list = employeeDao.findAll();
        for (Employee employee : list) {
            System.out.println(employee);
        }

        // Thread.sleep(10000);

        context.close();
    }

    @Test
    public void testSave() {
        Employee e = new Employee("admin", 28);
        e.setSalary(4234.56);
        employeeDao.save(e);
    }

    @Test
    public void testDeleteByName() {
        employeeDao.deleteByName("admin");
    }

    @Test
    public void testDelete() {
        Employee e = employeeDao.findByName("admin");
        employeeDao.delete(e.getId());
    }

    @Test
    public void testFindByName() {
        Employee e = employeeDao.findByName("admin");
        System.out.println(e);
    }

    @Test
    public void testFindOne() {
        Employee e = employeeDao.findByName("admin");
        Employee e2 = employeeDao.findOne(e.getId());
        System.out.println(e2);
    }
}

 

和xml配置时编写的测试类区别不大，就是

@ContextConfiguration(classes = { MongoConfiguration.class })

 

这里有了变化

 

5、扩展：MongoDB添加用户

use admin
db.createUser({user: "admin", pwd: "123456", roles:[{role: "root", db: "admin" }]})

use test
db.createUser({user: "xugf", pwd:"123456", roles:[{role:"dbOwner", db:"test"}]})

 

6、参考资料

Spring Data MongoDB
https://github.com/spring-projects/spring-data-mongodb