Java + 原生MongoDB驅動 API 使用案例詳說(兩種方式)
前不久,博主利用spring-boot結合spring-data-mongodb包,搞了一把mongodb的整合 -- 增刪改查
這種方式,比較固執,使用起來雖然方便,但是太依賴spring,我想建立自己的dbname,都無從下手(可能我還沒探究到),只能使用配置檔案裡面一開始就預設的url
很煩,我不知道我要建立資料庫A、B、C.....什麼的,要怎麼做? 而且查詢也非常繁瑣,so,本篇打算用原生的MongoDB API進行mongodb的使用,不難,看了後,就可以舉一反三了,好了,我們開始吧!
一、pom依賴
注:由於博主習慣使用Spring-Boot框架寫demo,因此,下面貼出來的pom符合Spring-Boot的依賴規範,但是,明眼人一眼就可以看出MongoDB API 用到的兩個依賴是什麼
pom.xml
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.appleyk</groupId> <artifactId>Spring-Boot-MongoAPI</artifactId> <version>0.0.1-SNAPSHOT</version> <name>MongoDB-API</name> <description>使用Java原生MongoDB_API進行資料的儲存和訪問</description> <!-- 繼承官網最新父POM【假設當前專案不再繼承其他POM】 --> <!-- http://projects.spring.io/spring-boot/#quick-start --> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.9.RELEASE</version> </parent> <!-- 使用Java8,嘗試使用新特新【stream和lambda】 --> <properties> <java.version>1.8</java.version> <mongodb.version>3.6.3</mongodb.version> </properties> <dependencies> <!-- Starter POMs是可以包含到應用中的一個方便的依賴關係描述符集合 --> <!-- 該Starters包含很多你搭建專案, 快速執行所需的依賴, 並提供一致的, 管理的傳遞依賴集。 --> <!-- 大多數的web應用都使用spring-boot-starter-web模組進行快速搭建和執行。 --> <!-- spring-boot-starter-web --> <!-- 對全棧web開發的支援, 包括Tomcat和 spring-webmvc --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency><!-- 新增Mybatis、Spring-Mybatis依賴 --> <!-- Spring 單元測試 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <!-- JUnit單元測試 --> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> </dependency> <!-- 新增熱部署 devtools:監聽檔案變動 --> <!-- 當Java檔案改動時,Spring-boo會快速重新啟動 --> <!-- 最簡單的測試,就是隨便找一個檔案Ctrl+S一下,就可以看到效果 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <!-- optional=true,依賴不會傳遞 --> <!-- 本專案依賴devtools;若依賴本專案的其他專案想要使用devtools,需要重新引入 --> <optional>true</optional> </dependency> <dependency> <groupId>org.mongodb</groupId> <artifactId>mongo-java-driver</artifactId> <version>${mongodb.version}</version><!--$NO-MVN-MAN-VER$--> </dependency> <dependency> <groupId>org.mongodb</groupId> <artifactId>bson</artifactId> <version>${mongodb.version}</version> </dependency> </dependencies> </project>
注意兩個地方
1、版本一定要統一,否則,出現未知的異常(比如說:‘’為什麼我的資料儲存不上,博主你的卻可以呢? ”)我可不管
2、關鍵的兩個依賴包
下面開始,只貼程式碼,說明都在註釋裡面了,希望需要的朋友對照自己的專案進行拷貝改造,別往執行看效果!!!
二、API使用快速入門 ☞ Document物件
QuickStartTest.java
import static com.mongodb.client.model.Filters.*; import static com.mongodb.client.model.Updates.*; import java.util.Arrays; import java.util.HashMap; import java.util.Map; import org.bson.Document; import org.junit.Test; import com.mongodb.MongoClient; import com.mongodb.client.MongoCollection; import com.mongodb.client.MongoCursor; import com.mongodb.client.MongoDatabase; import com.mongodb.client.result.DeleteResult; import com.mongodb.client.result.UpdateResult; public class QuickStartTest { MongoClient mongoClient = new MongoClient("localhost" , 27017); //或者使用下面的方法,使用連線字串進行構建Mongo客戶端例項 // MongoClientURI connectionString = new MongoClientURI("mongodb://localhost:27017"); // MongoClient mongoClient = new MongoClient(connectionString); /** * 一旦有了連線到MongoDB部署的MongoClient例項,就可以使用MongoClient.getdatabase()方法來訪問資料庫。 * 將資料庫的名稱指定到getDatabase()方法。如果資料庫不存在,MongoDB將在您第一次為該資料庫儲存資料時建立資料庫 * 資料庫例項不可變 */ MongoDatabase database = mongoClient.getDatabase("mydb"); /** * * 一旦有了DB例項後,就使用它的getCollection()方法來訪問一個集合。 * 將集合的名稱指定到getCollection()方法。如果一個集合不存在,MongoDB將在您第一次為該集合儲存資料時建立集合。 */ /** * 例如,使用資料庫例項,下面的語句訪問mydb資料庫中的名為test的集合 * 集合不可變 */ MongoCollection<Document> collection = database.getCollection("test"); /** * 存入一條資料【插入一個文件物件】 */ @Test public void SaveOne(){ /** * 有了DB例項、Collection集合後,就該儲存文件(資料)了 * 要使用Java驅動程式建立文件,請使用Document(文件)類 --org.bson.Document * 要使用Java驅動程式建立文件,例項化一個具有欄位和值的文件物件 * new Document(Map<String,Object>) 或者 new Document(key,value) * 並使用其append()方法將其他欄位和值包含到文件物件中 * 該值可以是另一個文件物件,以指定嵌入的文件 */ /** * 資料(含文件套文件) : { "name" : "MongoDB", "type" : "nosqlDB", "count" : 1, "versions": [ "v3.6", "v3.0", "v2.6" ], "info" : { x : 203, y : 102 } } */ Map<String, Object> map = new HashMap<>(); map.put("x", 203); map.put("y", 102); Document document = new Document("name","MongoDB") .append("type", "nosqlDB") .append("count", 1) .append("versions", Arrays.asList("v3.6","v3.0","v2.6")) .append("info", new Document(map)); /** * 有了文件物件後,就是向集合collection中儲存了 * 也可以批量插入List<Document>,方法為collection.insertMany(documents); */ collection.insertOne(document); /** * 要計算集合中的文件數,可以使用集合的count()方法。 */ System.err.println("count of documents from collection is :"+collection.count()); } /** * 無條件取出(查詢)第一個文件物件(第一條資料) */ @Test public void findOne(){ Document doc = collection.find().first(); System.err.println("只取【test】集合中的第一個文件物件:"+doc.toJson()); } /** * 無條件取出(查詢)所有的文件物件(所有資料) */ @Test public void findAll(){ /** * 要檢索集合中的所有文件,我們將使用find()方法,而不需要任何引數。 * 為了遍歷結果,將iterator()方法連結到find()中。 * 迭代器類似SQL的遊標cursor */ MongoCursor<Document> cursor = collection.find().iterator(); try { /** * 如果迭代到下一個物件等於false,退出迭代,並關閉迭代器 */ int index = 0; while (cursor.hasNext()) { System.err.println((index+1)+":"+cursor.next().toJson()); index++; } } finally { cursor.close(); } System.err.println("=======不推薦下面的遍歷法"); /** * 雖然可以允許迭代使用下面的習慣用法,但避免使用它,因為如果迴圈提前終止,應用程式可能會洩漏一個遊標: */ for (Document cur : collection.find()) { System.err.println(cur.toJson()); } } /** * 帶條件查詢文件物件 */ @Test public void queryOne(){ /** * 要查詢匹配某些條件的文件,請將filter物件傳遞給find()方法。 * 為了方便建立過濾器物件,Mongo-Java驅動程式提供了過濾器幫助器。 */ /** * 查詢count == 1 的文件物件 */ Document doc = collection.find(eq("count", 1)).first(); if(doc!=null){ System.err.println("條件1查詢結果:"+doc.toJson()); }else{ System.err.println("條件1查詢結果:無"); } /** * 查詢count<2 且 name.equals("Mongo")的文件物件,顯然不存在 * 如果查詢全部符合條件的文件集合,請使用find(*).iterator() */ doc = collection.find(and(lt("count",2),eq("name", "Mongo"))).first(); if(doc!=null){ System.err.println("條件2查詢結果:"+doc.toJson()); }else{ System.err.println("條件2查詢結果:無"); } /** * Filters * gt gte === > >= * lt lte === < <= * eq === == * and === 相當於 sql語句的 where xxx and xxx * or === 相當於 sql語句的 where xxx or xxx */ } /** * 更新文件 -- ByOne */ @Test public void updateOne(){ /** * 要更新集合中的文件,使用集合的updateOne方法更新單個文件物件 * * $set 相當於 sql語句的 update collection set type = "database" where name = "MongoDB" limit 1 */ UpdateResult result = collection.updateOne(eq("name", "MongoDB"), new Document("$set", new Document("type", "database"))); System.err.println("更新影響的行數:"+result.getModifiedCount()); } /** * 批量更新文件 -- ByMany */ @Test public void updateMany(){ /** * 要更新集合中的文件,使用集合的updateMany方法更新所有符合條件的文件物件 * 下面更新所有name等於"MongoDB"的文件物件的count屬性 +100 */ UpdateResult result = collection.updateMany(eq("name", "MongoDB"), inc("count", 100)); System.err.println("更新影響的行數:"+result.getModifiedCount()); } /** * 刪除文件 -- ByOne */ @Test public void deleteOne(){ /** * 刪除第一個type.equals("nosqlDB")的文件物件 */ DeleteResult result = collection.deleteOne(eq("type", "nosqlDB")); System.err.println("刪除影響的行數:"+result.getDeletedCount()); } /** * 批量刪除文件 -- ByMany */ @Test public void deleteMany(){ /** * 刪除所有count>=100的文件物件 */ DeleteResult result = collection.deleteMany(gte("count", 100)); System.err.println("刪除影響的行數:"+result.getDeletedCount()); } }
注意一個地方
Mongo查詢和更新的過濾器,需要引入這兩個靜態包,別忘啦(除非你拷貝了整個demo)
來幾個測試效果圖
1、儲存單條文件
查詢
2、按條件查詢
其餘不在演示
三、API使用快速入門 ☞ Pojos物件
先來兩個Java實體類Country.java
public final class Country {
private String name;
private String province;
private String city;
public Country() {
}
public Country(String name , String pro, String city) {
this.name = name ;
this.province = pro;
this.city = city;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getProvince() {
return province;
}
public void setProvince(String province) {
this.province = province;
}
public String getCity() {
return city;
}
public void setCity(String city) {
this.city = city;
}
}
Person.java
import org.bson.types.ObjectId;
public final class Person {
/**
* MongoDB自動分配的ID
*/
private ObjectId id;
private String name;
private int age;
private Country country;
public Person() {
}
public Person(String name , int age,Country country){
this.name = name ;
this.age = age ;
this.country = country;
}
public ObjectId getId() {
return id;
}
public void setId(final ObjectId id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(final String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(final int age) {
this.age = age;
}
public Country getCountry() {
return country;
}
public void setCountry(Country country) {
this.country = country;
}
@Override
public String toString(){
return "name:"+name+",age:"+age+",國家:"+country.getName()+",省/州:"
+country.getProvince()+",市:"+country.getCity();
}
}
再來個測試用例類
QuickStartPojosTest.java
import static org.bson.codecs.configuration.CodecRegistries.fromProviders;
import static org.bson.codecs.configuration.CodecRegistries.fromRegistries;
import static com.mongodb.client.model.Filters.*;
import java.util.Arrays;
import java.util.List;
import org.bson.codecs.configuration.CodecProvider;
import org.bson.codecs.configuration.CodecRegistry;
import org.bson.codecs.pojo.PojoCodecProvider;
import org.junit.Test;
import com.appleyk.entity.Country;
import com.appleyk.entity.Person;
import com.mongodb.MongoClient;
import com.mongodb.client.MongoCollection;
import com.mongodb.client.MongoDatabase;
public class QuickStartPojosTest {
/**
* 在使用驅動程式使用POJO之前,您需要配置CodecRegistry以包含一個codecs來處理從bson到POJO的轉換
* 要做到這一點,最簡單的方法是使用PojoCodecProvider.builder()來建立和配置一個CodecProvider
* 下面的示例將合併預設的codec登錄檔,並將PojoCodecProvider配置為自動建立PojoCodecs
*/
CodecProvider pojoCodecProvider = PojoCodecProvider.builder().automatic(true).build();
CodecRegistry pojoCodecRegistry = fromRegistries(MongoClient.getDefaultCodecRegistry(),
fromProviders(pojoCodecProvider));
/**
* 設定pojoCodecRegistry的方法有多種 可以在例項化MongoClient物件時設定它
* 1.MongoClient mongoClient = new MongoClient("localhost", MongoClientOptions.builder().codecRegistry(pojoCodecRegistry).build());
* 也可以在建立database的時候使用它
* 2.database = database.withCodecRegistry(pojoCodecRegistry);
* 3.也可以在使用集合的時候使用它
* collection = collection.withCodecRegistry(pojoCodecRegistry);
*/
/**
* 客戶端例項不可變
*/
MongoClient mongoClient = new MongoClient("localhost", 27017);
/**
* 資料庫例項不可變
*/
MongoDatabase database = mongoClient.getDatabase("mydb").withCodecRegistry(pojoCodecRegistry);
/**
* 集合不可變
*/
MongoCollection<Person> collection = database.getCollection("people", Person.class);
/**
* 插入單個Person實體物件
*/
@Test
public void SaveOne() {
Person person = new Person("appleyk", 20, new Country("中國", "河南省", "鄭州市"));
collection.insertOne(person);
System.err.println("儲存成功!");
}
/**
* 批量插入
*/
@Test
public void SaveMany() {
List<Person> persons = Arrays.asList(
new Person("kobe", 38, new Country("美國", "加利福尼亞州", "洛杉磯市"))
,new Person("劉翔", 33, new Country("中國", "上海", "上海市")));
collection.insertMany(persons);
System.err.println("儲存成功!");
}
/**
* 查詢集合中的第一個pojo物件 === pojos的查詢 等同於 documents的查詢
*/
@Test
public void findOne(){
Person person = collection.find().first();
System.err.println(person);
}
/**
* 根據過濾條件進行單個Person實體物件的查詢
*/
@Test
public void queryOne(){
Person person = collection.find(eq("name","kobe")).first();
System.err.println(person);
}
/**
* ..............此處省略100行程式碼,自己補充
*/
}
同理,注意一個地方 --- 靜態包的手動引入
效果演示
1、儲存多條
其餘不再演示
有問題請留言
喜歡的給個贊
------------------------------------------------學習使人快樂!