Code ví dụ Spring Boot RESTful Webservice với MongoDB

Code ví dụ Spring Boot RESTful Webservice với MongoDB

(Xem lại: Web Service là gì?)

(Xem lại: Giới thiệu về RESTful web service.)

(Xem lại: Code ví dụ, tạo RESTful Web Service với Spring MVC)

(Xem lại: Code ví dụ Spring Boot RESTful Webservice (CRUD))

(Xem lại: Hướng dẫn MongoDB, Java với MongoDB)

Các công nghệ sử dụng:

Code ví dụ

Ở bài này mình sẽ tạo API Webservice để thêm, sửa, xóa, lấy dữ liệu từ database MongoDB.

Tạo Spring Boot Project:

Code ví dụ Spring Boot RESTful Webservice với MongoDB

 

Tạo Spring Boot WebService với MongoDB

Cấu trúc Project

Code ví dụ Spring Boot RESTful Webservice với MongoDB

Khi tạo project Spring Boot nó sẽ tự động thêm các thư viện jackson để mapping dữ liệu trả về sang dạng JSON

File cấu hình Spring Boot

Trong file cấu hình Spring Boot ta cấu hình kết nối tới server MongoDB, ở đây mình kết nối tới database stackjava

spring.data.mongodb.uri=mongodb://localhost:27017/stackjava

File Entity

package stackjava.com.mongodb.entities;

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

@Document(collection = "customer")
public class Customer {
  @Id
  private String id;

  private String name;

  private String address;

  // getter - setter
}
  • Annotation @Document tương tự như annotation @Table khi làm việc với JPA, nó sẽ thực hiện mapping class với collection tương ứng, ví dụ ở đây sẽ mapping với collection player
  • Annotation @Id đánh dấu khóa chính, nếu bạn không truyền id lúc insert thì nó sẽ tự động tạo id cho bạn.

File Repository

Phần kết nối, truy vấn mình dùng MongoRepository

package stackjava.com.mongodb.repository;

import org.springframework.data.mongodb.repository.MongoRepository;
import org.springframework.stereotype.Repository;

import stackjava.com.mongodb.entities.Customer;

@Repository
public interface CustomerRepository extends MongoRepository<Customer, String> {
    
}

File Service

File service sẽ kiểm tra dữ liệu đầu vào, gọi tới repository để lấy dữ liệu và trả về cho Controller.

package stackjava.com.mongodb.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import stackjava.com.mongodb.entities.Customer;
import stackjava.com.mongodb.repository.CustomerRepository;
import stackjava.com.mongodb.service.ServiceResult.Status;

@Service
public class CustomerService {

  @Autowired
  CustomerRepository customerRepo;

  public ServiceResult findAll() {
    ServiceResult result = new ServiceResult();
    result.setData(customerRepo.findAll());
    return result;
  }

  public ServiceResult findById(String id) {
    ServiceResult result = new ServiceResult();
    Customer customer = customerRepo.findById(id).orElse(null);
    result.setData(customer);
    return result;
  }

  public ServiceResult create(Customer customer) {
    ServiceResult result = new ServiceResult();
    result.setData(customerRepo.save(customer));
    return result;
  }

  public ServiceResult update(Customer customer) {
    ServiceResult result = new ServiceResult();

    if (!customerRepo.findById(customer.getId()).isPresent()) {
      result.setStatus(Status.FAILED);
      result.setMessage("Customer Not Found");
    } else {
      result.setData(customerRepo.save(customer));
    }
    return result;
  }

  public ServiceResult delete(String id) {
    ServiceResult result = new ServiceResult();

    Customer customer = customerRepo.findById(id).orElse(null);
    if (customer == null) {
      result.setStatus(Status.FAILED);
      result.setMessage("Customer Not Found");
    } else {
      customerRepo.delete(customer);
      result.setMessage("success");
    }
    return result;
  }
}

Ở đây tất cả dữ liệu trả về đều là ServiceResult, thay vì trả về mỗi dữ liệu query, mình sẽ có thêm các thông tin như status, message thông báo trong trường hợp lỗi… Các bạn có thể thêm các trường khác như error_code… để phía client biết rõ lỗi gặp phải là gì, hay thêm đa ngôn ngữ vào message trả về…

package stackjava.com.mongodb.service;

public class ServiceResult {
  private Status status = Status.SUCCESS;
  private String message;
  private Object data;

  public enum Status {
    SUCCESS, FAILED;
  }

  // getter - setter

}

File Request

Ngoài trừ API GET, dữ liệu được truyền qua path của URL thì tất cả dữ liệu của các API DELETE, PUT, POST đều phải là dữ liệu JSON.

Ví dụ trường hợp xóa, mình cần truyền id lên thì mình sẽ tạo một class để wrap lại id đó.

package stackjava.com.mongodb.controller;

public class DeleteCustomerRequest {
  private String id;

  public String getId() {
    return id;
  }

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

}

Các trường hợp tạo, sửa Customer mình sử dụng lại class Customer.javacho nhanh. Còn trong thực tế thì các bạn nên tạo class Request riêng cho nó nhé, ví dụ lúc tạo thì không yêu cầu id, còn lúc sửa thì phải yêu cầu id.

File Controller

package stackjava.com.mongodb.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import stackjava.com.mongodb.entities.Customer;
import stackjava.com.mongodb.service.CustomerService;
import stackjava.com.mongodb.service.ServiceResult;

@RestController
@RequestMapping("/api/v1")
public class CustomerController {

  @Autowired
  private CustomerService customerService;

  /* ---------------- GET ALL CUSTOMER ------------------------ */
  @GetMapping("/customers")
  public ResponseEntity<ServiceResult> findAllCustomer() {
    return new ResponseEntity<ServiceResult>(customerService.findAll(), HttpStatus.OK);
  }

  /* ---------------- GET CUSTOMER BY ID ------------------------ */
  @GetMapping("/customers/{id}")
  public ResponseEntity<ServiceResult> findById(@PathVariable String id) {
    return new ResponseEntity<ServiceResult>(customerService.findById(id), HttpStatus.OK);
  }

  /* ---------------- CREATE NEW CUSTOMER ------------------------ */
  @PostMapping("/customers")
  public ResponseEntity<ServiceResult> create(@RequestBody Customer customer) {
    return new ResponseEntity<ServiceResult>(customerService.create(customer), HttpStatus.OK);
  }
  
  /* ---------------- UPDATE CUSTOMER ------------------------ */
  @PutMapping("/customers")
  public ResponseEntity<ServiceResult> update(@RequestBody Customer customer) {
    return new ResponseEntity<ServiceResult>(customerService.update(customer), HttpStatus.OK);
  }

  @DeleteMapping("/customers")
  public ResponseEntity<ServiceResult> delete(@RequestBody DeleteCustomerRequest request) {
    return new ResponseEntity<ServiceResult>(customerService.delete(request.getId()), HttpStatus.OK);
  }

}

Demo:

Khởi động MongoDB và chạy project.

Ở đây mình dùng postman extension trên chrome để gửi các request thêm, sửa, xóa, update đối tượng customer.

Request tạo Customer:

Mình tạo 2 customer là {"name":"sena", "address":"korean"} và {"name":"kai", "address":"viet nam"}

Code ví dụ Spring Boot RESTful Webservice với MongoDB

Kết quả trả về sẽ có id của đối tượng customer được tạo ra.

Code ví dụ Spring Boot RESTful Webservice với MongoDB

Request lấy tất cả các đối tượng Customer:

Code ví dụ Spring Boot RESTful Webservice với MongoDB

Request lấy tất đối tượng Customer theo id:

Code ví dụ Spring Boot RESTful Webservice với MongoDB

Request Update đối tượng Customer:

Ở đây mình sửa address của “kai” thành “usa”

Code ví dụ Spring Boot RESTful Webservice với MongoDB

Request Xóa đối tượng Customer:

Ở đây mình xóa customer “sena”

Code ví dụ Spring Boot RESTful Webservice với MongoDB

Xác nhận lại bằng request find all:

Kết quả: không còn customer “sena”, customer “kai” đã được sửa address thành “usa”

Code ví dụ Spring Boot RESTful Webservice với MongoDB

 

Okay, done!

Download code ví dụ trên tại đây.

 

References:

https://docs.spring.io/spring-data/../reference/html/

https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/

Trả lời

Email của bạn sẽ không được hiển thị công khai. Các trường bắt buộc được đánh dấu *

DMCA.com Protection Status stackjava.com