MongoDB是最流行的NoSQL數(shù)據(jù)庫,SpringBoot是使用Spring的最佳實踐酌呆。今天帶大家講一講SpringBoot集成MongoDB的兩種方式,MongoDB的安裝自行去官網(wǎng)查詢搔耕,本地開發(fā)最方便的做法是使用Docker方式隙袁。
一、準備工作
1弃榨、工程生成
老規(guī)矩菩收,使用https://start.spring.io/ 選擇我們要依賴的jar包,生成一個demo惭墓,然后導(dǎo)入到Idea中
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
# 以下方式也可以,可以根據(jù)喜好來配置
# spring.data.mongodb.uri=mongodb://springmongo:springmongo@localhost:27017/springmongo
二腊凶、使用MongoTemplate
1划咐、創(chuàng)建實體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參數(shù)指定這個類對應(yīng)的文檔风瘦。@Document(collection="mongodb 對應(yīng) collection 名")
@Id
文檔的唯一標識队魏,在mongodb中為ObjectId,它是唯一的
@Indexed
聲明該字段需要索引,建索引可以大大的提高查詢效率胡桨。
@CompoundIndex
復(fù)合索引的聲明官帘,建復(fù)合索引可以有效地提高多字段的查詢效率。
@Field
給映射存儲到 mongodb 的字段取別名
@Dbref
標識引用其他文檔昧谊,這個文檔有可能在另外的數(shù)據(jù)庫中
@Version
標識改屬性作為版本控制
@Transient
默認情況下所有的私有字段都映射到文檔刽虹,該注解標識的字段從存儲在數(shù)據(jù)庫中的字段列中排除(即該字段不保存到 mongodb)
2、定義接口
/**
* @author 公-眾-號:程序員阿牛
*/
public interface UserInfoDAO {
public UserInfo save(UserInfo userInfo);
public UserInfo getUser(String userId);
}
3呢诬、接口實現(xiàn)
/**
* @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涌哲、定義調(diào)用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、結(jié)果
使用idea自帶的httpclient測試一下
測試結(jié)果如下:
三尚镰、使用MongoRepository
1阀圾、定義接口
/**
* @author 公-眾-號:程序員阿牛
* 這里使用的spring-data抽象的Repository接口,有興趣的可以自己去研究一下
*/
@Repository
public interface UserInfoRepository extends MongoRepository<UserInfo, String> {
}
通過繼承接口狗唉,spring data會自動實現(xiàn)基本的crud方法初烘,同時,還支持通過方法的形式擴展自己想要的方法分俯,例如通過以下關(guān)鍵詞擴展(圖片在網(wǎng)上找的):
自定義查詢方法账月,格式為“find/get/readBy+字段名+方法后綴”,方法傳進的參數(shù)即字段的值澳迫。
支持的部分常用方法后綴有:
2、定義調(diào)用的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剧劝、結(jié)果
使用idea自帶的httpclient測試一下
測試結(jié)果如下:
小結(jié)
本文基于的SpringBoot版本是2.5.4橄登,兩種方式都可以實現(xiàn)與Spring的集成,具體使用哪一種根據(jù)實際的需要即可
關(guān)注我讥此,下一篇繼續(xù)