介绍java
在这篇文章中，我将展现如何使用Spring Boot和MongoDB构建一个简单的CRUD REST应用程序示例。我知道你的第一个问题是MongoDB是什么?web
MongoDB是什么?spring
MongoDB是一个NoSQL文档数据库。在这个数据库中，记录是document，其行为很像JSON对象。因此它主要是键值对。mongodb
使用MongoDB做为数据库的主要优势是:数据库
- MongoDB是一种无模式文档数据库。一个集合包含不一样的文档。
- 单个对象的结构是清晰的。
- 没有复杂的链接。
- 深查询能力。
- 易于扩展。
如下是在企业应用中使用MongoDB或相似的NoSQL数据库的几个缘由:服务器
- 更快的JSON数据检索。
- 很容易在属性上添加索引。
- 用于分片——分片是跨多台机器存储数据记录的过程。在跨多台机器存储数据时，一般会根据某些标准对数据进行分区。
- 更新快。
- 容易查询。
先决条件app
要建立这个示例应用程序，你须要:编辑器
- Spring Boot(版本2.4.1)
- MongoDB
- Gradle
- Java
Spring Boot CRUD应用程序spring-boot
做为本文的一部分，我将构建一个REST CRUD应用程序。这包括gradle
-
一个图书馆-咱们将在MongoDB数据库中建立一个图书馆集合。
-
咱们将按做者来存放这些书。
-
用户能够调用REST API按做者检索图书。
-
用户能够调用REST API来检索图书馆中的全部图书。
-
POST - /v1/mongodbapp/books -添加一本书。
-
GET - /v1/mongodbapp/books——从库中检索全部的图书。
-
GET - /v1/mongodbapp/books/id -检索特定的图书。
-
DELETE—/v1/mongodbapp/books/id—从库中删除一本书。
如何使用MongoDB和Spring Boot CRUD
为了开始建立这个应用程序，咱们将使用gradle来处理咱们的依赖并构建应用程序。在Spring Boot应用程序中添加如下依赖项:
implementation 'org.springframework.boot:spring-boot-starter-data-mongodb' implementation 'org.springframework.boot:spring-boot-starter-web'
一旦咱们有了这些依赖，咱们将可以链接到mongodb数据库。可是咱们仍然须要添加数据库的位置。咱们将在application.properties中添加所需的属性。以下:
spring.data.mongodb.host = localhostspring.data.mongodb.port=27017 spring.data.mongodb.database=library
这将容许咱们链接到运行在主机localhost上的端口27017上的MongoDB数据库，而且数据库是library。
定义数据模型
做为图书馆的一部分，咱们将须要书籍。咱们的主要数据对象是Book。这个数据模型将包括书名、做者和ISBN。具体内容以下:
package com.betterjavacode.mongodbdemo.mongodbapp.models;import org.springframework.data.annotation.Id;import org.springframework.data.mongodb.core.mapping.Document;@Document(collection = "books")public class Book{ @Id private String id; private String title; private String author; private String isbn; public Book() { } public Book(String title, String author, String isbn) { this.title = title; this.author = author; this.isbn = isbn; } public String getId() { return id; } public void setId(String id) { this.id = id; } public String getTitle() { return title; } public void setTitle(String title) { this.title = title; } public String getAuthor() { return author; } public void setAuthor(String author) { this.author = author; } public String getIsbn() { return isbn; } public void setIsbn(String isbn) { this.isbn = isbn; }}
由于咱们使用的是MongoDB，因此@Document注释覆盖了集合书籍。
添加Repository接口
咱们须要一个Repository库接口来获取、保存或删除book对象。在repositories包中，咱们将添加BookRepository接口：
package com.betterjavacode.mongodbdemo.mongodbapp.repositories;import com.betterjavacode.mongodbdemo.mongodbapp.models.Book;import org.springframework.data.mongodb.repository.MongoRepository;import java.util.List;public interface BookRepository extends MongoRepository<Book, String>{ List findByTitleContaining(String title); List findByAuthor(String name);}
这个Repository库有两个方法：能够经过标题或做者姓名获取图书。
添加Spring REST API控制器
如今，为了使咱们的应用程序REST CRUD，咱们将添加一个REST控制器。这个控制器将包含POST、PUT、GET和DELETE API。
package com.betterjavacode.mongodbdemo.mongodbapp.controller;import com.betterjavacode.mongodbdemo.mongodbapp.models.Book;import com.betterjavacode.mongodbdemo.mongodbapp.repositories.BookRepository;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.http.HttpStatus;import org.springframework.http.ResponseEntity;import org.springframework.web.bind.annotation.*;import java.util.ArrayList;import java.util.List;import java.util.Optional;@CrossOrigin("http://localhost:8080")@RestController@RequestMapping("/v1/mongodbapp")public class BookController{ @Autowired BookRepository bookRepository; @GetMapping("/books") public ResponseEntity<List> getAllBooks(@RequestParam(required = false) String bookTitle) { try { List listOfBooks = new ArrayList<>(); if(bookTitle == null || bookTitle.isEmpty()) { bookRepository.findAll().forEach(listOfBooks::add);} else { bookRepository.findByTitleContaining(bookTitle).forEach(listOfBooks::add); } if (listOfBooks.isEmpty()) { return new ResponseEntity<>(HttpStatus.NO_CONTENT); } return new ResponseEntity<>(listOfBooks, HttpStatus.OK); } catch (Exception e) { return new ResponseEntity<>(null, HttpStatus.INTERNAL_SERVER_ERROR); } } @GetMapping("/books/{id}") public ResponseEntity getBookById(@PathVariable("id") String id) { try { Optional bookOptional = bookRepository.findById(id); return new ResponseEntity<>(bookOptional.get(), HttpStatus.OK); } catch (Exception e) { return new ResponseEntity<>(null, HttpStatus.INTERNAL_SERVER_ERROR); } } @PostMapping("/books") public ResponseEntity addABookToLibrary(@RequestBody Book book) { try { Book createdBook = bookRepository.save(new Book(book.getTitle(), book.getAuthor(), book.getIsbn())); return new ResponseEntity<>(createdBook, HttpStatus.CREATED); } catch (Exception e) { return new ResponseEntity<>(null, HttpStatus.INTERNAL_SERVER_ERROR); } } @PutMapping("/books/{id}") public ResponseEntity updateABook(@PathVariable("id") String id, @RequestBody Book book) { Optional bookOptional = bookRepository.findById(id); if (bookOptional.isPresent()) { Book updatedBook = bookOptional.get(); updatedBook.setTitle(book.getTitle()); updatedBook.setAuthor(book.getAuthor()); updatedBook.setIsbn(book.getIsbn()); return new ResponseEntity<>(bookRepository.save(updatedBook), HttpStatus.OK); } else { return new ResponseEntity<>(HttpStatus.NOT_FOUND); } } @DeleteMapping("/books/{id}") public ResponseEntity deleteABook(@PathVariable("id") String id) { try { bookRepository.deleteById(id); return new ResponseEntity<>(HttpStatus.NO_CONTENT); } catch (Exception e) { return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR); } }}
BookController 是咱们的REST控制器类。它包括
- @RestController -将其标记为REST控制器。
- @CrossOrigin -这个注释容许跨源资源共享(CORS)。这将在REST响应中添加CORS访问控制头。这些头是必需的，由于它容许服务器不只指定谁能够访问资源，并且指定如何访问资源。
- 咱们添加了不一样的方法——addabooktolilibrary将书籍添加到数据库，getAllBooks从数据库中检索书籍。
完整的演示
如今咱们已经添加了REST控制器、Repository库方法，咱们将构建并运行这个应用程序。做为演示的一部分，我将使用POSTMAN来访问API。
能够从命令行或正在使用的代码编辑器构建应用程序。我更喜欢命令行，因此我已经构建了应用程序。一旦编译完成，你就能够像下面这样运行程序:
java -jar mongodbapp-0.0.1-SNAPSHOT.jar
让咱们用POSTMAN给咱们的图书馆添加书籍。
如上所示，咱们添加了一本书，响应将在数据库中显示已添加的书。
下面的API是一个GET API，用于从数据库中获取全部书籍。
如今，为了显示从库中删除图书，咱们将使用delete API。
结论
在这篇文章中，我展现了如何在使用MongoDB数据库时使用Spring Boot建立REST API。咱们使用的方法与使用常规SQL数据库时的方法很是类似。在使用NoSQL数据库时，咱们必须添加一些更改。