T O P

[资源分享]     Spring系列之集成MongoDB的2种方法

  • By - 楼主

  • 2021-09-13 14:00:16
  • MongoDB是最流行的NoSQL数据库,SpringBoot是使用Spring的最佳实践。今天带大家讲一讲SpringBoot集成MongoDB的两种方式,MongoDB的安装自行去官网查询,本地开发最方便的做法是使用Docker方式。

    一、准备工作

    1、工程生成

    老规矩,使用https://start.spring.io/ 选择我们要依赖的jar包,生成一个demo,然后导入到Idea中
    file

    2、配置项

    在application.properties文件中,配置MongoDB的地址

    spring.data.mongodb.database=springmongo
    spring.data.mongodb.username=springmongo
    spring.data.mongodb.password=springmongo
    spring.data.mongodb.host=localhost
    spring.data.mongodb.port=27017
    # 以下方式也可以,可以根据喜好来配置
    # spring.data.mongodb.uri=mongodb://springmongo:springmongo@localhost:27017/springmongo
    

    二、使用MongoTemplate

    1、创建实体UserInfo

    import lombok.Data;
    import org.springframework.data.annotation.Id;
    import org.springframework.data.mongodb.core.mapping.Document;
    /**
     * @author 公-众-号:程序员阿牛
     * @Id是Spring的注解,注意不要和Mybatis的搞混
     * @Document是MongoDB的注解
     */
    @Data
    @Document
    public class UserInfo {
        @Id
        private String userId;
        private String userName;
        private Integer age;
        private String address;
    }
    

    @Document与@Entity类似,表明是一个实体,@Id表明是主键

    其他的Spring data mongoDB注解还有:

    @Document

    把一个java类声明为mongodb的文档,可以通过collection参数指定这个类对应的文档。@Document(collection="mongodb 对应 collection 名")

    @Id

    文档的唯一标识,在mongodb中为ObjectId,它是唯一的

    @Indexed

    声明该字段需要索引,建索引可以大大的提高查询效率。

    @CompoundIndex

    复合索引的声明,建复合索引可以有效地提高多字段的查询效率。

    @Field

    给映射存储到 mongodb 的字段取别名

    @Dbref

    标识引用其他文档,这个文档有可能在另外的数据库中

    @Version

    标识改属性作为版本控制

    @Transient

    默认情况下所有的私有字段都映射到文档,该注解标识的字段从存储在数据库中的字段列中排除(即该字段不保存到 mongodb)

    2、定义接口

    /**
     * @author 公-众-号:程序员阿牛
     */
    public interface UserInfoDAO {
    
        public UserInfo save(UserInfo userInfo);
    
        public UserInfo getUser(String userId);
    }
    
    

    3、接口实现

    /**
     * @author 公-众-号:程序员阿牛
     */
    @Repository
    public class UserInfoDaoImpl implements UserInfoDAO {
        @Autowired
        private MongoTemplate mongoTemplate;
    
        @Override
        public UserInfo save(UserInfo userInfo) {
            return mongoTemplate.save(userInfo);
        }
    
        @Override
        public UserInfo getUser(String userId) {
            UserInfo userInfo = mongoTemplate.findOne(Query.query(Criteria.where("userId").is(userId)),UserInfo.class);
            return userInfo;
        }
    }
    

    4、定义调用controller

    /**
     * @author 公-众-号:程序员阿牛
     */
    @RestController
    public class UserInfoController {
        @Autowired
        private UserInfoDAO userInfoDAO;
        @RequestMapping("/getUser/{userId}")
        public UserInfo getUserInfo(@PathVariable("userId")String userId){
            return userInfoDAO.getUser(userId);
        }
    
        @PostMapping("/addUser")
        public UserInfo addUserInfo(@RequestBody UserInfo userInfo){
            return userInfoDAO.save(userInfo);
        }
    
    }
    

    5、结果

    使用idea自带的httpclient测试一下
    file

    测试结果如下:
    file

    三、使用MongoRepository

    1、定义接口

    /**
     * @author 公-众-号:程序员阿牛
     * 这里使用的spring-data抽象的Repository接口,有兴趣的可以自己去研究一下    
     */
    @Repository
    public interface UserInfoRepository extends MongoRepository<UserInfo, String> {
    }
    

    通过继承接口,spring data会自动实现基本的crud方法,同时,还支持通过方法的形式扩展自己想要的方法,例如通过以下关键词扩展(图片在网上找的):

    自定义查询方法,格式为“find/get/readBy+字段名+方法后缀”,方法传进的参数即字段的值。

    支持的部分常用方法后缀有:
    file
    file

    2、定义调用的controller

    /**
     * @author 公-众-号:程序员阿牛
     */
    @RestController
    public class UserInfo2Controller {
        @Autowired
        private UserInfoRepository userInfoRepository;
        @RequestMapping("/getUser2/{userId}")
        public Optional<UserInfo> getUserInfo(@PathVariable("userId")String userId){
            return userInfoRepository.findById(userId);
        }
    
        @PostMapping("/addUser2")
        public UserInfo addUserInfo(@RequestBody UserInfo userInfo){
            return userInfoRepository.save(userInfo);
        }
    
    }
    
    

    3、结果

    使用idea自带的httpclient测试一下
    file
    测试结果如下:
    file

    小结

    本文基于的SpringBoot版本是2.5.4,两种方式都可以实现与Spring的集成,具体使用哪一种根据实际的需要即可
    关注我,下一篇继续
    file

    本帖子中包含资源

    您需要 登录 才可以下载,没有帐号?立即注册