Skip to content

Latest commit

 

History

History
 
 

spring-boot-webflux-simple-service

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src/main
src/main
 
 
README.md
README.md
 
 
pom.xml
pom.xml
 
 

README.md

spring-boot-webflux-simple-service

ตัวอย่างการเขียน Spring-boot WebFlux Simple Service

1. เพิ่ม Dependencies

pom.xml

...
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.5.RELEASE</version>
</parent>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-webflux</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>

    <dependency>
        <groupId>org.hibernate</groupId>
        <artifactId>hibernate-core</artifactId>
        <version>5.4.3.Final</version>
    </dependency>

    <dependency>
        <groupId>org.postgresql</groupId>
        <artifactId>postgresql</artifactId>
        <version>42.2.5</version>
    </dependency>

    <dependency>
        <groupId>com.zaxxer</groupId>
        <artifactId>HikariCP</artifactId>
        <version>3.3.1</version>
    </dependency>

    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <scope>provided</scope>
    </dependency>
</dependencies>

...

dependencies

  • spring-boot-starter-webflux ใช้สำหรับเขียน webflux
  • spring-boot-starter-data-jpa ไว้สำหรับเขียนคำสั่ง query, method query
  • hibernate-core สำหรับทำ ORM (Object Relational Mapping) ไว้เขียนพวก entity class สำหรับ mapping java class ไปยัง database table รวมถึงการ mapping พวก relation ต่าง ๆ ของ table เช่น One to One, One to Many, Many to Many
  • postgresql เป็น postgresql database driver
  • HikariCP เป็นตัวจัดการ database connection pool
  • lombok เป็น annotation code generator สามารถ generate code at compile time ได้ ทำให้เราไม่ต้องเขียน code บางส่วนเอง เช่น getter setter method ตัว lombox จะทำให้

2. เขียน Main Class

AppStarter.java

@SpringBootApplication
@ComponentScan(basePackages = {"com.pamarin"}) 
public class AppStarter {

    public static void main(String[] args) {
        SpringApplication.run(AppStarter.class, args);
    }

}

3. เขียน entity

User.java

@Data
@Entity
@Table(name = User.TABLE_NAME)
public class User implements Serializable {

    public static final String TABLE_NAME = "user";

    @Id
    private String id;

    @Column(name = "username", nullable = false, unique = true)
    private String username;

    @Column(name = "password", nullable = false)
    private String password;

    @OneToMany(fetch = FetchType.LAZY, mappedBy = "user")
    private List<UserAuthority> userAuthorities;

    public List<UserAuthority> getUserAuthorities() {
        if (userAuthorities == null) {
            userAuthorities = new ArrayList<>();
        }
        return userAuthorities;
    }

}
  • @Data เป็น annotation ของ lombox เอาไว้ generate code เช่น getter/setter method, hashcode + equals ให้
  • @Entity เป็น annotation ที่เอาไว้ระบุว่า class นี้เป็น entity class
  • @Table เป็น annotation ที่เอาไว้ระบุว่าให้ class นี้ map ไปที่ database table ใด
  • @Id เป็น annotation ที่เอาไว้ระบุว่าจะให้ attribute ใดเป็น primary key
  • @Column เป็นการใช้ระบุข้อมูล column

4. เขียน Repository

UserRepository.java

public interface UserRepository extends JpaRepository<User, String>{
    
}

5. เขียน DTO (Data Transfer Object)

ในที่นี้เราจะไม่พ่น Object Entity ซึ่งเป็นโครงสร้างของ Table ออกไปโดยตรง แต่จะแปลงเป็น DTO ก่อน แล้วค่อยพ่นออกไปทาง API หรือ RESTful อีกที เนื่องจาก

  • DTO ถือเป็น View เป็น Abstraction Layer ระหว่าง Business กับ Database Structure คือ ต่อให้มีการปรับเปลี่ยนโครงสร้าง Database หรือการจัดเก็บข้อมูลหลังบ้านอื่น ๆ ก็ไม่ทำให้กระทบต่อโครงสร้าง API ที่เรา ได้ Design ไว้ เพราะเรา Design แยกกัน
  • DTO ทำให้เรา Focus ไปที่บทบาท หน้าที่ ของ API นั้น ๆ ว่ามันทำอะไร ใช้ข้อมูลแค่ไหน โดยไม่ต้องสนใจโครงสร้างการจัดเก็บจริง ๆ หน้าจอ GUI เราต้องการข้อมูลแค่ไหน ลักษณะไหน เราก็ Design API หรือ DTO ที่มารองรับแค่นั้น

UserDetailsDto.java

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class UserDetailsDto {

    private String id;

    private String name;

    private List<AuthorityDto> authorities;

    public List<AuthorityDto> getAuthorities() {
        if (authorities == null) {
            authorities = new ArrayList<>();
        }
        return authorities;
    }

    @Getter
    @Setter
    @Builder
    @NoArgsConstructor
    @AllArgsConstructor
    public static class AuthorityDto {

        private String id;

        private String name;

        private String description;

    }

}

6. เขียน Service

ประกาศ interface UserDetailsService.java

public interface UserDetailsService {

    List<UserDetailsDto> findAll();

    Optional<UserDetailsDto> findByUserId(String id);

}

implement interface UserDetailsServiceImpl.java

@Service
@Transactional(propagation = Propagation.REQUIRED)
public class UserDetailsServiceImpl implements UserDetailsService {

    private final UserRepository userRepository;

    @Autowired
    public UserDetailsServiceImpl(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    @Override
    public Optional<UserDetailsDto> findByUserId(String id) {
        return userRepository.findById(id)
                .map(this::convertToUserDetailsDto);
    }

    private UserDetailsDto convertToUserDetailsDto(User user) {
        return UserDetailsDto.builder()
                .id(user.getId())
                .name(user.getUsername())
                .authorities(
                        user.getUserAuthorities()
                                .stream()
                                .map(this::convertToAuthorityDto)
                                .collect(toList())
                )
                .build();
    }

    private UserDetailsDto.AuthorityDto convertToAuthorityDto(UserAuthority userAuthority) {
        Authority authority = userAuthority.getAuthority();
        return UserDetailsDto.AuthorityDto.builder()
                .id(userAuthority.getId().getAuthorityId())
                .name(authority.getName())
                .description(authority.getDescription())
                .build();
    }

    @Override
    public List<UserDetailsDto> findAll() {
        return userRepository.findAll()
                .stream()
                .map(this::convertToUserDetailsDto)
                .collect(toList());
    }

}
  • @Service เป็นการบอกว่า class นี้เป็น Service
  • @Transactional คือ Service นี้มีการใช้ Transaction (TX)
  • @Transactional(propagation = Propagation.REQUIRED) เป็นการใช้ Transaction (TX) แบบ required ซึ่งจริง ๆ แล้ว ไม่ต้องกำหนดก็ได้ เพราะ default จะเป็น REQUIRED อยู่แล้ว

Transaction Propagation

ที่ใช้บ่อย ๆ จะมี 2 ตัวคือ

  • Propagation.REQUIRED เป็นการบอกว่า method ภายใน service (class) นี้ required transaction ถ้ามีการใช้ transaction ครอบก่อน call service นี้แล้ว ให้ใช้ transaction เดิมต่อได้เลย โดยไม่ต้อง new transaction ขึ้นมาใหม่ แต่ถ้าไม่มีค่อย new transaction ขึ้นมาใหม่

ตัวอย่าง

   A() -> B() -> C()

สมมติว่า method A() มีการใช้ Transaction แล้ว call method B() ซึ่ง B() เป็น Propagation.REQUIRED method B() จะใช้ Transaction เดิมต่อจาก method A() เลย โดยไม่ new Transaction ขึ้นมาใหม่ แต่หาก method A() ไม่มีการใช้ Transaction มาก่อน method B() ถึงจะ new Transaction ขึ้นมาใหม่
และถ้า method C() เป็น Propagation.REQUIRED ก็จะใช้ Transaction เดิมต่อจาก A() และ B()
การ commit หรือ rollback จะเกิดขึ้นเป็น Atomic คือ success ก็จะ success ทั้งหมด แต่ถ้า fail ก็จะ fail ทั้งหมดเหมือนกัน

  • Propagation.REQUIRES_NEW เป็นการบอกว่า method ภายใน service (class) นี้ requires new transaction คือให้ new transaction ขึ้นมาใหม่เสมอ เมื่อมีการ call service นี้

ตัวอย่าง

   A() -> B() -> C()

ถ้าทั้ง method A(), B() และ C() เป็น Propagation.REQUIRES_NEW หมายความว่า ทั้ง 3 methods นี้จะใช้ Transaction คนละตัวกัน
การ commit ของ C() จะไม่มีผลต่อ B() และ A()
การ commit ของ A() ก็ไม่มีผลต่อ B() และ C()
ถ้า success ก็ success ของใครของมัน
และถ้า fail ก็ rollback ของใครของมัน

สามารถอ่านเพิ่มเติมได้ที่ https://docs.spring.io/spring/docs/current/spring-framework-reference/data-access.html#tx-propagation

7. เรียกใช้งาน Service ผ่าน Controller

UserDetailsController.java

@RestController
public class UserDetailsController {

    private final UserDetailsService userDetailsService;

    @Autowired
    public UserDetailsController(UserDetailsService userDetailsService) {
        this.userDetailsService = userDetailsService;
    }

    @GetMapping({"", "/"})
    public Flux<UserDetailsDto> home() {
        return findAll();
    }

    @GetMapping("/user-details")
    public Flux<UserDetailsDto> findAll() {
        return Flux.fromIterable(userDetailsService.findAll());
    }


    @GetMapping("/user-details/{id}")
    public Mono<UserDetailsDto> findById(@PathVariable("id") String id) {
        return Mono.justOrEmpty(userDetailsService.findByUserId(id))
                .switchIfEmpty(Mono.error(new NotFoundException("Not found user of id " + id)));
    }

}

8. Config application.properties

#------------------------------------ JPA --------------------------------------
spring.jpa.hibernate.ddl-auto=none
spring.jpa.properties.hibernate.cache.use_second_level_cache=false
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
spring.jpa.hibernate.use-new-id-generator-mappings=true
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.proc.param_null_passing=true
spring.jpa.properties.hibernate.default_schema=*****

#------------------------------------ Hikari -----------------------------------
spring.datasource.hikari.minimumIdle=1
spring.datasource.hikari.maximumPoolSize=10
spring.datasource.hikari.idleTimeout=30000
spring.datasource.hikari.connectionTestQuery=SELECT 1 FROM DUAL
spring.datasource.hikari.validationTimeout=3000

#------------------------------------ Postgresql -------------------------------
spring.datasource.url=jdbc:postgresql:*****
spring.datasource.username=*****
spring.datasource.password=*****
spring.datasource.driver-class-name=org.postgresql.Driver
spring.datasource.platform=postgres
spring.datasource.type=org.postgresql.ds.PGSimpleDataSource

9. Build

cd ไปที่ root ของ project จากนั้น

$ mvn clean install

10. Run

$ mvn spring-boot:run \
    -Dserver.port=8080 \
    -Dspring.datasource.url=jdbc:postgresql://<HOST>:<PORT>/<DATABASE_NAME>?sslmode=require \
    -Dspring.datasource.username=<DATABASE_USERNAME> \
    -Dspring.datasource.password=<DATABASE_PASSWORD> \
    -Dspring.jpa.properties.hibernate.default_schema=<DATABASE_SCHEMA>

ให้เปลี่ยน ค่า <> เป็นของตัวเองน่ะครับ

  • HOST คือ ip หรือ domain name ของ database server
  • PORT คือ port ที่ใช้
  • DATABASE_NAME คือ ชื่อ database
  • DATABASE_USERNAME คือ ชื่อ username ที่ login เข้าใช้งาน database
  • DATABASE_PASSWORD คือ รหัสผ่านที่คู่กับ username ที่ใช้
  • DATABASE_SCHEMA คือ database schema ที่่ใช้

11. เข้าใช้งาน

เปิด browser แล้วเข้า http://localhost:8080