《深入实践Spring Boot》一2.3　使用MongoDB

本节书摘来自华章出版社《深入实践Spring Boot》一书中的第2章，第2.3节，作者陈韶健，更多章节内容可以访问“华章计算机”公众号查看。

2.3　使用MongoDB

在当前流行的NoSQL数据库中，MongoDB是大家接触比较早而且用得比较多的数据库。MongoDB是文档型的NoSQL数据库，具有大数据量、高并发等优势，但缺点是不能建立实体关系，而且也没有事务管理机制。

2.3.1　MongoDB依赖配置

在Spring Boot中使用MongoDB也像使用JPA一样容易，并且同样拥有功能完善的资源库。同样的，要使用MongoDB，首先必须在工程的Maven中引入它的依赖，如代码清单2-14所示。除了MongoDB本身的依赖之外，还需要一些附加的工具配套使用。
代码清单2-14　使用MongoDB的Maven依赖配置

<dependencies>
    <dependency>
        <groupId>org.springframework.data</groupId>
        <artifactId>spring-data-mongodb</artifactId>
    </dependency>
    <dependency>
        <groupId>org.pegdown</groupId>
        <artifactId>pegdown</artifactId>
        <version>1.4.1</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-hateoas</artifactId>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-annotations</artifactId>
    </dependency>
</dependencies>

2.3.2　文档建模

MongoDB是文档型数据库，使用MongoDB也可以像使用关系型数据库那样为文档建模。如代码清单2-15所示，为用户文档建模，它具有用户名、密码、用户名称、邮箱和注册日期等字段，有一个用来保存用户角色的数据集，还定义了一个构造函数，可以很方便地用来创建一个用户实例。
代码清单2-15　用户文档建模

@Document(collection = "user")
public class User {
    @Id
    private String userId;
    @NotNull @Indexed(unique = true)
    private String username;
    @NotNull
    private String password;
    @NotNull
    private String name;
    @NotNull
    private String email;
    @NotNull
    private Date registrationDate = new Date();
    private Set<String> roles = new HashSet<>();

    public User() { }

    @PersistenceConstructor
    public User(String userId, String username, String password, String name, String email,
            Date registrationDate, Set<String> roles) {
        this.userId = userId;
        this.username = username;
        this.password = password;
        this.name = name;
        this.email = email;
        this.registrationDate = registrationDate;
        this.roles = roles;

    }
……

2.3.3　文档持久化

MongoDB也有像使用JPA那样的资源库，如代码清单2-16所示，为用户文档创建了一个Repository接口，继承于MongoRepository，实现了文档持久化。
代码清单2-16　用户文档持久化
public interface UserRepository extends MongoRepository {

User findByUsername(String username);

}

MongoRepository的继承关系如图2-4所示，看起来跟JPA的资源库的继承关系没有什么两样，它也包含访问数据库的丰富功能。
代码清单2-17是用在测试中的使用MongoDB的一个配置类定义，其中@PropertySource指定读取数据库配置文件的位置和名称，@EnableMongoRepositories启用资源库并设定定义资源库接口放置的位置，这里使用环境变量Environment来读取配置文件的一些数据库配置参数，然后使用一个数据库客户端，连接MongoDB服务器。
代码清单2-17　TestDataSourceConfig配置类

@Configuration
@EnableMongoRepositories(basePackages = "dbdemo.mongo.repositories")
@PropertySource("classpath:test.properties")
public class TestDataSourceConfig extends AbstractMongoConfiguration {

    @Autowired private Environment env;

    @Override
    public String getDatabaseName(){
        return env.getRequiredProperty("mongo.name");
    }

    @Override
    @Bean
    public Mongo mongo() throws Exception {
        ServerAddress serverAddress = new ServerAddress(env.getRequiredProperty
("mongo.host"));
        List<MongoCredential> credentials = new ArrayList<>();
        return new MongoClient(serverAddress, credentials);
    }

}

2.3.4　MongoDB测试

如果还没有安装MongoDB服务器，可以参照附录B的方法安装并启动一个MongoDB服务器。然后，使用如代码清单2-18所示的配置方法配置连接服务器的一些参数，该配置假定你的MongoDB服务器安装在本地，并使用默认的数据库端口：27017。
代码清单2-18　MongoDB数据库配置

MongoDB

mongo.host=localhost
mongo.name=test
mongo.port=27017
这样就可以编写一个JUint测试例子来测试UserRepository接口的使用情况，如代码清单2-19所示。测试例子首先使用用户文档类创建一个用户对象实例，然后使用资源库接口调用save方法将用户对象保存到数据库中，最后使用f?indAll方法查询所有用户的列表，并使用一个循环输出用户的简要信息。
代码清单2-19　MongoDB测试

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = {TestDataSourceConfig.class})
@FixMethodOrder
public class RepositoryTests {
    private static Logger logger = LoggerFactory.getLogger(RepositoryTests.class);

@SuppressWarnings("SpringJavaAutowiringInspection") @Autowired
UserRepository userRepository;

@Before
public void setup(){
    Set<String> roles = new HashSet<>();
    roles.add("manage");
    User user = new User("1","user","12345678","name","email@com.cn",new Date(),

roles);

    userRepository.save(user);
}

@Test
public void findAll(){
    List<User> users = userRepository.findAll();
    Assert.notNull(users);
    for(User user : users){
        logger.info("===user=== userid:{}, username:{}, pass:{}, registra

tionDate:{}",
                user.getUserId(), user.getName(), user.getPassword(), user.
getRegistrationDate());
        }
    }
}

现在可以在IDEA的Run/Debug Conf?iguration配置中增加一个JUint测试项目，模块选择mongodb，工作目录选择模块所在的工程根目录，类选择上面编写的测试例子，即dbdemo.mongo.test.RepositoryTests，并将配置保存为mongotest。
使用Debug方式运行测试项目mongotest。如果通过测试，将输出查到的用户的简要信息，如下所示：
dbdemo.mongo.test.RepositoryTests - ===user=== userid:1, username:name, pass:12345678, registrationDate:Tue Jun 07 14:26:02 CST 2016
这时使用MongoDB数据库客户端输入下面的查询指令，也可以查到这条文档的详细信息，这是一条JSON结构的文本信息。

> db.user.find()
{ "_id" : "1", "_class" : "dbdemo.mongo.models.User", "username" : "user", "password" : "12345678", "name" : "name", "email" : "email@com.cn", "registrationDate" : ISODate("2016-04-13T06:27:02.423Z"), "roles" : [ "manage" ] }

时间： 2024-09-20 04:25:49