springboot集成Mongodb詳細篇附詳細源碼

主要實現功能

• springboot與mongodb整合
• 加入swagger
• 標準rest接口實現demo(用戶增刪改查分頁)
• 泛型基類dao層封裝和實現增刪改查分頁

項目結構

部分測試截圖

swagger簡易查看

分頁

數據庫插入測試數據

單元測試插入模擬數據

 package com.lzp;

import com.lzp.entity.User;
import com.lzp.service.UserService;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

/**
 * Created by liuzp on 2017/11/23.
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserCtrlTest {

    @Autowired
    private UserService userService;
    /**
     * 插入測試數據
     * @throws Exception
     */
    @Test
    public void insert() throws Exception {
        for(int i = 0;i < 21; i++){
            User user = new User("name"+i,""+i);
            userService.insert(user);
        }
    }
}

pom.xml配置

    <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-web</artifactId>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.2.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.2.2</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

application.properties配置

#數據庫地址多個地址以逗號隔開
mongodb.host=192.168.4.156
#端口
mongodb.port=10001
#數據庫名稱
mongodb.name=test_lzp
#用戶名
mongodb.user=
#密碼
mongodb.password=
#是否開啓鑑權
mongodb.authentification=false

MongoConfig.java

package com.lzp.config;

import com.mongodb.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.mongodb.config.AbstractMongoConfiguration;
import org.springframework.data.mongodb.core.MongoTemplate;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

@Configuration
public class MongoConfig extends AbstractMongoConfiguration {

    private  Logger logger = LoggerFactory
            .getLogger(MongoConfig.class);

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

    @Value("${mongodb.port}")
    private int mongodbPort;

    @Value("${mongodb.name}")
    private String mongodbName;

    @Value("${mongodb.user}")
    private String mongodbUser;

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

    @Value("${mongodb.authentification}")
    private boolean authentification;

    @Bean
    @Override
    public MongoTemplate mongoTemplate() throws Exception {

        MongoTemplate mongoTemplate = 
            new MongoTemplate(mongo(), mongodbName);
        logger.info("*******"+mongoTemplate.getDb().getName() +"基礎庫");
        return mongoTemplate;

    }
    @Override
    protected String getDatabaseName() {
        return mongodbName;
    }

    @Override
    public Mongo mongo() throws Exception {

         MongoClient mongoClient;
         MongoCredential credential = MongoCredential.createMongoCRCredential(mongodbUser,mongodbName,mongodbpwd.toCharArray());
         MongoClientOptions options = MongoClientOptions.builder()
                .connectionsPerHost(3000)
                .threadsAllowedToBlockForConnectionMultiplier(10)
                .readPreference(ReadPreference.nearest())
                .build();
        List<ServerAddress> addresses = new ArrayList<ServerAddress>();
        String[] str = this.mongodbHost.split(",");
        for (String strHost : str) {
          ServerAddress address = new ServerAddress(strHost, mongodbPort);
          addresses.add(address);
        }
        if(authentification){
            mongoClient = new MongoClient(addresses,Arrays.asList(credential), options);
        }else{
             mongoClient = new MongoClient(addresses, options); 
        }

         return mongoClient;
    }
}

Swagger配置類

package com.lzp;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Created by liuzp on 2017/11/23.
 */
@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket crete() {
        return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.lzp.controller"))
        .paths(PathSelectors.any())
        .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
        .title("springboot 整合 mongodb 詳細例子")
        .contact("關注公衆號JAVA葵花寶典一起學習")
        .build();
    }

}

mongodb實體創建

package com.lzp.entity;

import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;

import java.io.Serializable;

/**
 * Created by liuzp on 2017/11/23.
 */
@Document(collection = "user")//指定表名
public class User implements Serializable{

    private static final long serialVersionUID = 1L;

    @Id
    private String id;//對應Mongodb主鍵_id

    private String userName;

    private String passWd;

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

    public User(){

    }

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPassWd() {
        return passWd;
    }

    public void setPassWd(String passWd) {
        this.passWd = passWd;
    }
}

封裝baseDao

• 接口

package com.lzp.dao;

import com.lzp.utils.Page;
import org.springframework.data.mongodb.core.query.Update;

/**
 * Created by liuzp on 2017/11/23.
 */
public interface BaseDao<T> {
    boolean remove(String id);

    T  get(String id);

    void insert(T t);

    boolean update(Update update, String id) ;

    Page list(Integer pageNum, Integer pageSize);

}

• 實現類

package com.lzp.dao;

import com.lzp.utils.Constants;
import com.lzp.utils.Page;
import com.mongodb.WriteResult;
import org.bson.types.ObjectId;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.query.Criteria;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.data.mongodb.core.query.Update;
import org.springframework.stereotype.Repository;

import java.lang.reflect.ParameterizedType;
import java.util.List;

/**
 * Created by liuzp on 2017/11/23.
 */
@Repository
public class BaseDaoImp<T> implements BaseDao<T> {

    @Autowired
    private MongoTemplate mongoTemplate;

    /**
     * 創建一個 Class 的對象來獲取泛型的 Class
     */
    private Class<T> clz;


    public Class<T> getClz(){
        if(clz==null){
            clz = ((Class<T>)(((ParameterizedType)(this.getClass().getGenericSuperclass())).getActualTypeArguments()[0]));
        }
        return clz;
    }



    @Override
    public boolean remove(String id) {
        Criteria criteria = Criteria.where("_id").is(new ObjectId(id));
        Query query = new Query(criteria);
        WriteResult writeResult =  mongoTemplate.remove(query, getClz());
        return  writeResult.getN() > 0 ? true :false;
    }

    @Override
    public T get(String id) {
        Criteria criteria = Criteria.where("_id").is(new ObjectId(id));
        Query query = new Query(criteria);
        return mongoTemplate.findOne(query,getClz());
    }

    @Override
    public void insert(T t) {
        mongoTemplate.insert(t);
    }

    @Override
    public boolean update(Update update,String id) {
        Criteria criteria = Criteria.where("_id").is(new ObjectId(id));
        Query query = new Query(criteria);
        WriteResult writeResult =mongoTemplate.updateFirst(query,update,getClz());
        return  writeResult.getN() > 0 ? true :false;
    }

    @Override
    public Page list(Integer pageNum, Integer pageSize) {
        pageNum = pageNum==null ? Constants.DEFAULT_PAGE_NUM: pageNum;
        pageSize = pageSize==null ? Constants.DEFAULT_PAGE_SIZE : pageSize;
        Query query = new Query();
        long totalCount = mongoTemplate.count(query,getClz());
        query.skip((pageNum - 1) * pageSize).limit(pageSize);
        List<T> list = mongoTemplate.find(query,getClz());
        Page page = new Page(pageNum,pageSize);
        page.setListData(list);
        page.setPageCount(totalCount);
        return page;
    }
}

標準restful Controllor接口

package com.lzp.controller;

import com.lzp.entity.User;
import com.lzp.service.UserService;
import com.lzp.utils.Constants;
import com.lzp.utils.Page;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

/**
 * Created by liuzp on 2017/11/23.
 */
@RestController
@RequestMapping("/user")
public class UserCtrl {

    @Autowired
    private UserService userService;

    /**
     * 根據主鍵查詢
     * @param id
     * @return
     */
    @RequestMapping(value = "/{id}",method = RequestMethod.GET)
    public User get(@PathVariable String id) {
        return userService.get(id);
    }

    /**
     * 根據主鍵刪除
     * @param id
     * @return
     */
    @RequestMapping(value = "/{id}",method = RequestMethod.DELETE)
    public String delete(@PathVariable String id) {
        return userService.remove(id)  ? Constants.SUCCESS : Constants.FAIL;
    }

    /**
     * 列表查詢帶分頁
     * @param pageNum
     * @param pageSize
     * @return
     */
    @RequestMapping(value = "/list",method = RequestMethod.GET)
    public Page list(Integer pageNum,Integer pageSize) {
        Page page  = userService.list(pageNum,pageSize);
        return  page;
    }

    /**
     * 修改
     * @param user
     * @return
     */
    @RequestMapping(value = "",method = RequestMethod.PUT)
    public String update(@RequestBody User user){
        return userService.update(user) ? Constants.SUCCESS : Constants.FAIL;
    }

    @RequestMapping(value = "",method = RequestMethod.POST)
    public String save(@RequestBody User user){
        userService.insert(user);
        return  Constants.SUCCESS;
    }

}

其他代碼略
項目源碼地址

歡迎關注我的公衆號 JAVA葵花寶典 ，一起學習交流