Tạo project mới#

Có 2 cách tạo project Spring Boot:
- Sử dụng Spring Initializr
- Sử dụng Spring Tool Suite (STS) hoặc IntelliJ IDEA
Mình sẽ tạo trên Spring Initializr, vì nó đơn giản và nhanh chóng.

alt text - Project: Maven

Language: Java 17
Spring Boot: 3.4.1
Dependencies:
- Lombok
- H2 Database
- Spring Data JPA
Cần thêm gì thì vô pom.xml add sau, 3 cái trên là cơ bản.

Coding#

User.java
- @Table(name = “users”): một bảng trong DB với tên users
- Điều kiện để trở thành một Entity là xài 2 annotation: @Entity, @Table
- Sử dụng những annotation của Lombok để giảm Boilerplate Code

1
package com.lcaohoanq.demo.domain.user;
2

3
import jakarta.persistence.*;
4
import lombok.*;
5

6
@Getter
7
@Setter
8
@Builder
9
@NoArgsConstructor
10
@AllArgsConstructor
11
@Entity
12
@Table(name = "users")
13
public class User {
14

15
    @Id
16
    @GeneratedValue(strategy = GenerationType.IDENTITY) //GenerationType.AUTO, GenerationType.SEQUENCE
17
    @Column(name = "id", nullable = false, updatable = false) //if not provide name="id", JPA will automatically using the field name is userId
18
    private Long userId;
19
    private String username;
20
    private String password;
21

22
}

UserDTO.java
- DTO (Data Transfer Object): record java 16+, giống với data class của kotlin, mình có một bài viết về record tại đây Java Record,

1
package com.lcaohoanq.demo.domain.user;
2

3
import com.fasterxml.jackson.annotation.JsonProperty;
4
import jakarta.validation.constraints.NotEmpty;
5
import jakarta.validation.constraints.Size;
6

7
public record UserDTO(
8
    @JsonProperty("username")
9
    @NotEmpty(message = "Username is required")
10
    @Size(min = 6, max = 20)
11
    String username,
12

13
    @JsonProperty("password")
14
    @NotEmpty(message = "Password is required")
15
    @Size(min = 6, max = 20)
16
    String password
17
) {}

UserRepository.java
- Sử dụng Repository Pattern DAO vs Repository thay vì dùng DAO (Data Access Object)
- Có thể dùng @Repository hoặc không vì JpaRepository đã dùng @Repository
- JpaRepository nhận 2 type là Entity và Data Type của PK của Entity đó (ở đây PK của User là Long userId) nên sẽ dùng Long

1
package com.lcaohoanq.demo.domain.user;
2

3
import org.springframework.data.jpa.repository.JpaRepository;
4
import org.springframework.stereotype.Repository;
5

6
public interface UserRepository extends JpaRepository<User, Long> {}

UserService.java
- Bussiness Logic
- @Transactional: hỗ trợ việc quản lý transaction, sử dụng ở class level hoặc method level, ở đây dùng method level

1
package com.lcaohoanq.demo.domain.user;
2

3
import com.lcaohoanq.demo.ResourceNotFoundException;
4
import lombok.RequiredArgsConstructor;
5
import org.springframework.stereotype.Service;
6
import org.springframework.transaction.annotation.Transactional;
7

8
@Service
9
@RequiredArgsConstructor
10
public class UserService {
11

12
    private final UserRepository userRepository;
13

14
    @Override
15
    @Transactional
16
    public User create(UserDTO userDTO) {
17
        User user = User.builder()
18
            .username(userDTO.username()) //record do not have prefix get like getUsername, be aware at this point
19
            .password(userDTO.password())
20
            .build();
21
        return userRepository.save(user);
22
    }
23

24
    @Override
25
    @Transactional
26
    public User update(Long id, UserDTO userDTO) {
27
        User existingUser = findById(id);
28
        existingUser.setUsername(userDTO.username());
29
        existingUser.setPassword(userDTO.password());
30
        return userRepository.save(existingUser);
31
    }
32

33
    @Override
34
    @Transactional
35
    public void delete(Long id) {
36
        User user = findById(id);
37
        userRepository.delete(user);
38
    }
39

40
    @Override
41
    public User findById(Long id) {
42
        return userRepository.findById(id)
43
            .orElseThrow(() -> new RuntimeException("User not found with id: " + id));
44
    }
45
}

UserController.java:
- @RestController: định nghĩa một REST API Endpoint
- @RequestMapping: áp dụng prefix cho tất cả endpoint trong class
- @GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping,… cho những HTTP request tương ứng
- Không khuyến khích sử dụng @Autowired -> Field Injection (tham khảo ở đây, Why using Autowired is not recommend, nên dùng @RequiredArgsContructor + private final -> Constructor Base Injection)
- @Valid sẽ kích hoạt validation trong DTO, chỉ hoạt động với @RequestBody là một Object

1
package com.lcaohoanq.demo.domain.user;
2

3
import jakarta.validation.Valid;
4
import lombok.RequiredArgsConstructor;
5
import org.springframework.*;
6

7
@RestController
8
@RequestMapping("${API_PREFIX}/users")
9
@RequiredArgsConstructor
10
public class UserController {
11

12
    private final UserService userService;
13
    private final UserRepository userRepository;
14

15
    @GetMapping("")
16
    public ResponseEntity<?> findAll(
17
        @RequestParam(defaultValue = "0") int page,
18
        @RequestParam(defaultValue = "10") int size)
19
    {
20
        return ResponseEntity.ok(userRepository.findAll(PageRequest.of(page, size)));
21
    }
22

23
    @GetMapping("/{id}")
24
    public ResponseEntity<User> getUser(@PathVariable Long id) {
25
        User user = userService.findById(id);
26
        return ResponseEntity.ok(user);
27
    }
28

29
    @PostMapping("/register")
30
    public ResponseEntity<User> create(
31
        @Valid @RequestBody UserDTO userDTO
32
    ) {
33
        User createdUser = userService.create(userDTO);
34
        return ResponseEntity.status(HttpStatus.CREATED).build();
35
    }
36

37
    @PutMapping("/{id}")
38
    public ResponseEntity<User> update(
39
        @PathVariable Long id,
40
        @Valid @RequestBody UserDTO userDTO
41
    ) {
42
        User updatedUser = userService.update(id, userDTO);
43
        return ResponseEntity.ok(updatedUser);
44
    }
45

46
    @DeleteMapping("/{id}")
47
    public ResponseEntity<Void> delete(@PathVariable Long id) {
48
        userService.delete(id);
49
        return ResponseEntity.noContent().build();
50
    }
51
}

Swagger UI#

Add thêm dependency vào pom.xml

1
<dependencies>
2
 <dependency>
3
   <groupId>org.springdoc</groupId>
4
   <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
5
   <version>2.6.0</version>
6
 </dependency>
7
<dependencies>

Config#

application.properties

1
spring.application.name=demo-crud-springboot-application
2

3
spring.output.ansi.enabled=ALWAYS
4

5
server.port=8080
6

7
# API
8
API_PREFIX=/api/v1
9

10
# H2 database configuration
11
spring.datasource.url=jdbc:h2:mem:testdb
12
spring.datasource.driverClassName=org.h2.Driver
13
spring.datasource.username=sa
14
spring.datasource.password=password
15
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
16

17
# JPA / Hibernate configuration
18
spring.jpa.hibernate.ddl-auto=create
19
spring.jpa.show-sql=true
20

21
# Swagger config
22
springdoc.swagger-ui.operations-sorter=method
23
springdoc.swagger-ui.tags-sorter=alpha
24
springdoc.api-docs.path=/v3/api-docs
25
springdoc.swagger-ui.path=/swagger-ui.html

Test#

Truy cập: http://localhost:8080/swagger-ui/index.html