Spring Boot(十一)：Spring Boot 中 MongoDB 的使用

純潔的微笑發表於2017-05-09
Spring BootMongoDB

MongoDB 是最早熱門非關聯式資料庫的之一，使用也比較普遍，一般會用做離線資料分析來使用，放到內網的居多。由於很多公司使用了雲服務，伺服器預設都開放了外網地址，導致前一陣子大批 MongoDB 因配置漏洞被攻擊，資料被刪，引起了人們的注意，感興趣的可以看看這篇文章：場屠戮MongoDB的盛宴反思：超33000個資料庫遭遇入侵勒索，同時也說明了很多公司生產中大量使用mongodb。

MongoDB 簡介

MongoDB（來自於英文單詞“Humongous”，中文含義為“龐大”）是可以應用於各種規模的企業、各個行業以及各類應用程式的開源資料庫。基於分散式檔案儲存的資料庫。由C++語言編寫。旨在為 WEB 應用提供可擴充套件的高效能資料儲存解決方案。MongoDB 是一個高效能，開源，無模式的文件型資料庫，是當前 NoSql 資料庫中比較熱門的一種。

MongoDB 是一個介於關聯式資料庫和非關聯式資料庫之間的產品，是非關聯式資料庫當中功能最豐富，最像關聯式資料庫的。他支援的資料結構非常鬆散，是類似 json 的 bjson 格式，因此可以儲存比較複雜的資料型別。MongoDB 最大的特點是他支援的查詢語言非常強大，其語法有點類似於物件導向的查詢語言，幾乎可以實現類似關聯式資料庫單表查詢的絕大部分功能，而且還支援對資料建立索引。

傳統的關聯式資料庫一般由資料庫（database）、表（table）、記錄（record）三個層次概念組成，MongoDB 是由資料庫（database）、集合（collection）、文件物件（document）三個層次組成。MongoDB 對於關係型資料庫裡的表，但是集合中沒有列、行和關係概念，這體現了模式自由的特點。

MongoDB 中的一條記錄就是一個文件，是一個資料結構，由欄位和值對組成。MongoDB 文件與 JSON 物件類似。欄位的值有可能包括其它文件、陣列以及文件陣列。MongoDB 支援 OS X、Linux 及 Windows 等作業系統，並提供了 Python，PHP，Ruby，Java及 C++ 語言的驅動程式，社群中也提供了對 Erlang 及 .NET 等平臺的驅動程式。

MongoDB 的適合對大量或者無固定格式的資料進行儲存，比如：日誌、快取等。對事物支援較弱，不適用複雜的多文件（多表）的級聯查詢。文中演示 Mongodb 版本為 3.5。

MongoDB 的增刪改查

Spring Boot 對各種流行的資料來源都進行了封裝，當然也包括了 Mongodb,下面給大家介紹如何在 Spring Boot 中使用 Mongodb：

1、pom 包配置

pom 包裡面新增 spring-boot-starter-data-mongodb 包引用

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

2、在 application.properties 中新增配置

spring.data.mongodb.uri=mongodb://name:pass@localhost:27017/test

多個 IP 叢集可以採用以下配置：

spring.data.mongodb.uri=mongodb://user:pwd@ip1:port1,ip2:port2/database

2、建立資料實體

public class User implements Serializable {
        private static final long serialVersionUID = -3258839839160856613L;
        private Long id;
        private String userName;
        private String passWord;

      //getter、setter省略
}

3、建立實體的增刪改查操作

Repository 層實現了 User 物件的增刪改查

@Component
public class UserRepositoryImpl implements UserRepository {

    @Autowired
    private MongoTemplate mongoTemplate;

    /**
     * 建立物件
     * @param user
     */
    @Override
    public void saveUser(User user) {
        mongoTemplate.save(user);
    }

    /**
     * 根據使用者名稱查詢物件
     * @param userName
     * @return
     */
    @Override
    public User findUserByUserName(String userName) {
        Query query=new Query(Criteria.where("userName").is(userName));
        User user =  mongoTemplate.findOne(query , User.class);
        return user;
    }

    /**
     * 更新物件
     * @param user
     */
    @Override
    public long updateUser(User user) {
        Query query=new Query(Criteria.where("id").is(user.getId()));
        Update update= new Update().set("userName", user.getUserName()).set("passWord", user.getPassWord());
        //更新查詢返回結果集的第一條
        UpdateResult result =mongoTemplate.updateFirst(query,update,User.class);
        //更新查詢返回結果集的所有
        // mongoTemplate.updateMulti(query,update,UserEntity.class);
        if(result!=null)
            return result.getMatchedCount();
        else
            return 0;
    }

    /**
     * 刪除物件
     * @param id
     */
    @Override
    public void deleteUserById(Long id) {
        Query query=new Query(Criteria.where("id").is(id));
        mongoTemplate.remove(query,User.class);
    }
}

4、開發對應的測試方法

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserDaoTest {

    @Autowired
    private UserDao userDao;

    @Test
    public void testSaveUser() throws Exception {
        UserEntity user=new UserEntity();
        user.setId(2l);
        user.setUserName("小明");
        user.setPassWord("fffooo123");
        userDao.saveUser(user);
    }

    @Test
    public void findUserByUserName(){
       UserEntity user= userDao.findUserByUserName("小明");
       System.out.println("user is "+user);
    }

    @Test
    public void updateUser(){
        UserEntity user=new UserEntity();
        user.setId(2l);
        user.setUserName("天空");
        user.setPassWord("fffxxxx");
        userDao.updateUser(user);
    }

    @Test
    public void deleteUserById(){
        userDao.deleteUserById(1l);
    }

}

5、檢視驗證結果

可以使用工具 MongoVUE 工具來連線後直接圖形化展示檢視，也可以登入伺服器用命令來檢視

1.登入 mongos

bin/mongo -host localhost -port 20000

2、切換到 test 庫

use test

3、查詢 user 集合資料

db.user.find()

根據3查詢的結果來觀察測試用例的執行是否正確。

到此 Spring Boot 對應 MongoDB 的增刪改查功能已經全部實現。

多資料來源 MongoDB 的使用

接下來實現 MongoDB 多資料來源的使用

1、pom 包配置

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

2、配置兩條資料來源，如下：

mongodb.primary.uri=mongodb://192.168.0.75:20000
mongodb.primary.database=primary
mongodb.secondary.uri=mongodb://192.168.0.75:20000
mongodb.secondary.database=secondary

3、配置兩個庫的資料來源

封裝讀取以 Mongodb 開頭的兩個配置檔案

@Data
@ConfigurationProperties(prefix = "mongodb")
public class MultipleMongoProperties {

    private MongoProperties primary = new MongoProperties();
    private MongoProperties secondary = new MongoProperties();
}

配置不同包路徑下使用不同的資料來源

第一個庫的封裝

@Configuration
@EnableMongoRepositories(basePackages = "com.neo.model.repository.primary",
        mongoTemplateRef = PrimaryMongoConfig.MONGO_TEMPLATE)
public class PrimaryMongoConfig {

    protected static final String MONGO_TEMPLATE = "primaryMongoTemplate";
}

第二個庫的封裝

@Configuration
@EnableMongoRepositories(basePackages = "com.neo.model.repository.secondary",
        mongoTemplateRef = SecondaryMongoConfig.MONGO_TEMPLATE)
public class SecondaryMongoConfig {

    protected static final String MONGO_TEMPLATE = "secondaryMongoTemplate";
}

讀取對應的配置資訊並且構造對應的 MongoTemplate

@Configuration
public class MultipleMongoConfig {

    @Autowired
    private MultipleMongoProperties mongoProperties;

    @Primary
    @Bean(name = PrimaryMongoConfig.MONGO_TEMPLATE)
    public MongoTemplate primaryMongoTemplate() throws Exception {
        return new MongoTemplate(primaryFactory(this.mongoProperties.getPrimary()));
    }

    @Bean
    @Qualifier(SecondaryMongoConfig.MONGO_TEMPLATE)
    public MongoTemplate secondaryMongoTemplate() throws Exception {
        return new MongoTemplate(secondaryFactory(this.mongoProperties.getSecondary()));
    }

    @Bean
    @Primary
    public MongoDbFactory primaryFactory(MongoProperties mongo) throws Exception {
        return new SimpleMongoDbFactory(new MongoClient(mongo.getHost(), mongo.getPort()),
                mongo.getDatabase());
    }

    @Bean
    public MongoDbFactory secondaryFactory(MongoProperties mongo) throws Exception {
        return new SimpleMongoDbFactory(new MongoClient(mongo.getHost(), mongo.getPort()),
                mongo.getDatabase());
    }
}

兩個庫的配置資訊已經完成。

4、建立兩個庫分別對應的物件和 Repository

對應可以共用

public class User implements Serializable {
        private static final long serialVersionUID = -3258839839160856613L;
        private String  id;
        private String userName;
        private String passWord;

        public User(String userName, String passWord) {
                this.userName = userName;
                this.passWord = passWord;
        }
}

對應的 Repository

public interface PrimaryRepository extends MongoRepository<PrimaryMongoObject, String> {
}

繼承了 MongoRepository 會預設實現很多基本的增刪改查，省了很多自己寫 Repository 層的程式碼

Secondary 和上面的程式碼類似就不貼出來了

5、最後測試

@RunWith(SpringRunner.class)
@SpringBootTest
public class MuliDatabaseTest {

    @Autowired
    private PrimaryRepository primaryRepository;

    @Autowired
    private SecondaryRepository secondaryRepository;

    @Test
    public void TestSave() {

        System.out.println("************************************************************");
        System.out.println("測試開始");
        System.out.println("************************************************************");

        this.primaryRepository
                .save(new PrimaryMongoObject(null, "第一個庫的物件"));

        this.secondaryRepository
                .save(new SecondaryMongoObject(null, "第二個庫的物件"));

        List<PrimaryMongoObject> primaries = this.primaryRepository.findAll();
        for (PrimaryMongoObject primary : primaries) {
            System.out.println(primary.toString());
        }

        List<SecondaryMongoObject> secondaries = this.secondaryRepository.findAll();

        for (SecondaryMongoObject secondary : secondaries) {
            System.out.println(secondary.toString());
        }

        System.out.println("************************************************************");
        System.out.println("測試完成");
        System.out.println("************************************************************");
    }

}

到此，MongoDB 多資料來源的使用已經完成。

文章內容已經升級到 Spring Boot 2.x

示例程式碼-github

示例程式碼-碼雲

相關文章