<div id="readability-page-1" class="page"><div>
												
<p>스프링 부트를 이용해 게시판을 생성해 봅니다.<br>
일반적인 프로젝트가 API 서버와 UI 가 분리되고,<br>
API 를 스프링이 담당하고,<br>
UI 부분은 자바스크립트가 대응하는 방식이라 저는 API 서버 구성하는 부분을 중점적으로 설명합니다.</p>
<p>UI 부분은 제가 잘 안하는 부분이라…<br>
설명을 하게 될지는 모르겠습니다.</p>
<h2>데이타베이스 생성</h2>
<p><a href="https://mariadb.org/download/">여기</a> 에서 MariaDB 를 다운받아 설치합니다.</p>
<p>UTF-8 as default server’s character set 를 체크합니다.</p>
<p>설치된 프로그램중 MySQL Client 를 실행하고 로그인합니다.</p>
<p>계정을 생성하고, 데이타베이스를 생성 후, 권한을 부여합니다.</p>
<pre><code>CREATE USER 'myuser'@'localhost' IDENTIFIED BY 'mypass';
CREATE USER 'myuser'@'%' IDENTIFIED BY 'mypass';

CREATE DATABASE myboard;

GRANT ALL PRIVILEGES ON myboard.* TO 'myuser'@'localhost';

FLUSH PRIVILEGES;

USE myboard;

CREATE TABLE `tbl_post` (
    `idx`           bigint(20)    NOT NULL AUTO_INCREMENT,
    `title`         varchar(100)  NOT NULL,
    `content`       varchar(3000) NOT NULL,
    `writer`        varchar(20)   NOT NULL,
    `view_cnt`      int(11)       NOT NULL DEFAULT 1,
    `delete_yn`     tinyint(1)    NOT NULL DEFAULT 0,
    `created_date`  DATETIME      NOT NULL DEFAULT current_timestamp(),
    `modified_date` datetime               DEFAULT NULL,
    PRIMARY KEY (`idx`)
);</code></pre>
<h2>insert/update/delete/select</h2>
<h3>프로젝트 생성</h3>
<p>IntelliJ 를 이용해 프로젝트를 생성해 줍니다.<br>
lombok, devtools, spring boot web, jpa 를 선택해 줍니다.</p>
<p><a href="https://www.skyer9.pe.kr/wordpress/?p=1596">여기</a> 를 참조하여 mapstruct 도 프로젝트에 추가합니다.</p>
<p>build.gradle</p>
<pre><code>dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.mapstruct:mapstruct:1.4.1.Final'
    compileOnly 'org.projectlombok:lombok'
    compileOnly 'org.projectlombok:lombok-mapstruct-binding:0.2.0'
    developmentOnly 'org.springframework.boot:spring-boot-devtools'
    runtimeOnly 'org.mariadb.jdbc:mariadb-java-client'
    annotationProcessor 'org.projectlombok:lombok'
    annotationProcessor 'org.mapstruct:mapstruct-processor:1.4.1.Final'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}</code></pre>
<h3>기본적인 흐름</h3>
<p>값의 입력과 결과값은 반환은 json 에 의해 이루어집니다.</p>
<p>사용자입력(json) -&gt; DTO -&gt; Data Object -&gt; DB<br>
사용자반환(json) &lt;- DTO &lt;- Data Object &lt;- DB</p>
<h3>Domain 레이어 생성</h3>
<p>스프링 부트 JPA 엔터티 생성방법에 대해서는 다른 문서를 찾아보시기 바랍니다.</p>
<p>Post.java</p>
<pre><code>@Entity
@Getter
@Setter
@Table(name = "tbl_post")
@NoArgsConstructor
public class Post {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long idx;

    @Column(length = 100, nullable = false)
    private String title;

    @Column(length = 3000, nullable = false)
    private String content;

    @Column(length = 20, nullable = false)
    private String writer;

    @Column(nullable = false)
    private Integer viewCnt = 1;

    @Column(nullable = false)
    private Integer deleteYn = 0;

    @Column(nullable = false)
    private LocalDateTime createdDate = LocalDateTime.now();

    @Column
    private LocalDateTime modifiedDate;
}</code></pre>
<p>PostRepository.java</p>
<pre><code>public interface PostRepository extends JpaRepository&lt;Post, Long&gt; {
}</code></pre>
<p>application.yml</p>
<pre><code>spring:
  datasource:
    url: jdbc:mariadb://${MYSQL_HOST:localhost}:3306/myboard
    username: myuser
    password: mypass
    driver-class-name: org.mariadb.jdbc.Driver
  jpa:
    hibernate:
      ddl-auto: none
    show-sql: false</code></pre>
<h3>Service 레이어 생성</h3>
<p>PostDto.java</p>
<pre><code>@Getter
@Setter
@NoArgsConstructor
public class PostDto {
    private Long idx;
    private String title;
    private String content;
    private String writer;
    private Integer viewCnt;
    private Integer deleteYn;
    private LocalDateTime createdDate;
    private LocalDateTime modifiedDate;
}</code></pre>
<p>GenericMapper.java</p>
<pre><code>public interface GenericMapper&lt;D, E&gt; {
    D toDto(E e);
    List&lt;D&gt; toDto(List&lt;E&gt; e);
    void updateFromDto(D dto, @MappingTarget E entity);
}</code></pre>
<p>PostMapper.java</p>
<pre><code>@Mapper(
        componentModel = "spring",
        unmappedTargetPolicy = ReportingPolicy.IGNORE,
        nullValuePropertyMappingStrategy = NullValuePropertyMappingStrategy.IGNORE
)
public interface PostMapper extends GenericMapper&lt;PostDto, Post&gt; {
}</code></pre>
<p>PostService.java</p>
<pre><code>@RequiredArgsConstructor
@Service
public class PostService {
    private final PostRepository postRepository;
    private final PostMapper mapper = Mappers.getMapper(PostMapper.class);

    @Transactional
    public PostDto insert(PostDto dto) {
        // validate(OperationMode.INSERT, dto);
        Post e = new Post();
        mapper.updateFromDto(dto, e);
        return mapper.toDto(postRepository.save(e));
    }

    @Transactional
    public PostDto update(PostDto dto) {
        // validate(OperationMode.UPDATE, dto);
        Post e = get(dto.getIdx());
        mapper.updateFromDto(dto, e);
        e.setModifiedDate(LocalDateTime.now());
        return mapper.toDto(postRepository.save(e));
    }

    @Transactional
    public void delete(Long idx) {
        Post e = get(idx);
        e.setModifiedDate(LocalDateTime.now());
        e.setDeleteYn(1);
    }

    @Transactional
    public void undelete(Long idx) {
        Post e = get(idx);
        e.setModifiedDate(LocalDateTime.now());
        e.setDeleteYn(0);
    }

    @Transactional
    public PostDto getOne(Long idx) {
        Post e = get(idx);
        e.setViewCnt(e.getViewCnt() + 1);
        return mapper.toDto(get(idx));
    }

    private Post get(Long idx) {
        Optional&lt;Post&gt; e = postRepository.findById(idx);
        if (e.isEmpty()) {
            throw new RuntimeException("data not found");
        }
        return e.get();
    }
}</code></pre>
<h3>Controller 레이어 생성</h3>
<pre><code>@RequiredArgsConstructor
@RestController
public class PostController {
    private final PostService service;

    @PostMapping("/api/v1/ins")
    public PostDto insert(@RequestBody PostDto dto) {
        return service.insert(dto);
    }

    @PostMapping("/api/v1/upd")
    public PostDto update(@RequestBody PostDto dto) {
        return service.update(dto);
    }

    @GetMapping("/api/v1/del")
    public void delete(@RequestParam("id") Long id) {
        service.delete(id);
    }

    @GetMapping("/api/v1/undel")
    public void undelete(@RequestParam("id") Long id) {
        service.undelete(id);
    }

    @GetMapping("/api/v1/")
    public PostDto get(@RequestParam("id") Long id) {
        return service.getOne(id);
    }
}</code></pre>
<h3>테스트</h3>
<p>VSCode 에 Thunder Client 플러그인을 설치하면 API 를 호출할 수 있습니다.</p>
<p><a href="https://www.skyer9.pe.kr/wordpress/wp-content/uploads/2024/03/2024-03-06-01.png"><img decoding="async" src="https://www.skyer9.pe.kr/wordpress/wp-content/uploads/2024/03/2024-03-06-01-300x88.png" alt=""></a></p>
<h2>list</h2>
<p>다른 API 와 다르게 생각해야 할 부분이 많지만,<br>
이 문서는 기초지식을 주목적으로 하기에,<br>
가장 간단한 형태의 검색을 구현합니다.</p>
<p>페이징을 구현하고, 검색조건은 없거나 1나의 검색조건을 구현합니다.</p>
<p><span></span> <span>Post Views:</span> <span>10</span>
			</p>											</div></div>

상구리의 기술 블로그

Spring Boot 게시판 생성하기
스프링 부트를 이용해 게시판을 생성해 봅니다.
UI 부분은 제가 잘 안하는 부분이라…
데이타베이스 생성
여기 에서 MariaDB 를 다운받아 설치합니다.
UTF-8 as default server’s character set 를 체크합니다.
설치된 프로그램중 MySQL Client 를 실행하고 로그인합니다.
계정을 생성하고, 데이타베이스를 생성 후, 권한을 부여합니다.
CREATE USER 'myuser'@'localhost' IDENTIFIED BY 'mypass';
CREATE USER 'myuser'@'%' IDENTIFIED BY 'mypass';
CREATE DATABASE myboard;
GRANT ALL PRIVILEGES ON myboard.* TO 'myuser'@'localhost';
FLUSH PRIVILEGES;
USE myboard;
CREATE TABLE `tbl_post` (
    `idx`           bigint(20)    NOT NULL AUTO_INCREMENT,
    `title`         varchar(100)  NOT NULL,
    `content`       varchar(3000) NOT NULL,
    `writer`        varchar(20)   NOT NULL,
    `view_cnt`      int(11)       NOT NULL DEFAULT 1,
    `delete_yn`     tinyint(1)    NOT NULL DEFAULT 0,
    `created_date`  DATETIME      NOT NULL DEFAULT current_timestamp(),
    `modified_date` datetime               DEFAULT NULL,
    PRIMARY KEY (`idx`)
);
insert/update/delete/select
프로젝트 생성
IntelliJ 를 이용해 프로젝트를 생성해 줍니다.
여기 를 참조하여 mapstruct 도 프로젝트에 추가합니다.
build.gradle
dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.mapstruct:mapstruct:1.4.1.Final'
    compileOnly 'org.projectlombok:lombok'
    compileOnly 'org.projectlombok:lombok-mapstruct-binding:0.2.0'
    developmentOnly 'org.springframework.boot:spring-boot-devtools'
    runtimeOnly 'org.mariadb.jdbc:mariadb-java-client'
    annotationProcessor 'org.projectlombok:lombok'
    annotationProcessor 'org.mapstruct:mapstruct-processor:1.4.1.Final'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}
기본적인 흐름
값의 입력과 결과값은 반환은 json 에 의해 이루어집니다.
사용자입력(json) -> DTO -> Data Object -> DB
Domain 레이어 생성
스프링 부트 JPA 엔터티 생성방법에 대해서는 다른 문서를 찾아보시기 바랍니다.
Post.java
@Entity
@Getter
@Setter
@Table(name = "tbl_post")
@NoArgsConstructor
public class Post {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long idx;
    @Column(length = 100, nullable = false)
    private String title;
    @Column(length = 3000, nullable = false)
    private String content;
    @Column(length = 20, nullable = false)
    private String writer;
    @Column(nullable = false)
    private Integer viewCnt = 1;
    @Column(nullable = false)
    private Integer deleteYn = 0;
    @Column(nullable = false)
    private LocalDateTime createdDate = LocalDateTime.now();
    @Column
    private LocalDateTime modifiedDate;
}
PostRepository.java
public interface PostRepository extends JpaRepository<Post, Long> {
}
application.yml
spring:
  datasource:
    url: jdbc:mariadb://${MYSQL_HOST:localhost}:3306/myboard
    username: myuser
    password: mypass
    driver-class-name: org.mariadb.jdbc.Driver
  jpa:
    hibernate:
      ddl-auto: none
    show-sql: false
Service 레이어 생성
PostDto.java
@Getter
@Setter
@NoArgsConstructor
public class PostDto {
    private Long idx;
    private String title;
    private String content;
    private String writer;
    private Integer viewCnt;
    private Integer deleteYn;
    private LocalDateTime createdDate;
    private LocalDateTime modifiedDate;
}
GenericMapper.java
public interface GenericMapper<D, E> {
    D toDto(E e);
    List<D> toDto(List<E> e);
    void updateFromDto(D dto, @MappingTarget E entity);
}
PostMapper.java
@Mapper(
        componentModel = "spring",
        unmappedTargetPolicy = ReportingPolicy.IGNORE,
        nullValuePropertyMappingStrategy = NullValuePropertyMappingStrategy.IGNORE
)
public interface PostMapper extends GenericMapper<PostDto, Post> {
}
PostService.java
@RequiredArgsConstructor
@Service
public class PostService {
    private final PostRepository postRepository;
    private final PostMapper mapper = Mappers.getMapper(PostMapper.class);
    @Transactional
    public PostDto insert(PostDto dto) {
        // validate(OperationMode.INSERT, dto);
        Post e = new Post();
        mapper.updateFromDto(dto, e);
        return mapper.toDto(postRepository.save(e));
    }
    @Transactional
    public PostDto update(PostDto dto) {
        // validate(OperationMode.UPDATE, dto);
        Post e = get(dto.getIdx());
        mapper.updateFromDto(dto, e);
        e.setModifiedDate(LocalDateTime.now());
        return mapper.toDto(postRepository.save(e));
    }
    @Transactional
    public void delete(Long idx) {
        Post e = get(idx);
        e.setModifiedDate(LocalDateTime.now());
        e.setDeleteYn(1);
    }
    @Transactional
    public void undelete(Long idx) {
        Post e = get(idx);
        e.setModifiedDate(LocalDateTime.now());
        e.setDeleteYn(0);
    }
    @Transactional
    public PostDto getOne(Long idx) {
        Post e = get(idx);
        e.setViewCnt(e.getViewCnt() + 1);
        return mapper.toDto(get(idx));
    }
    private Post get(Long idx) {
        Optional<Post> e = postRepository.findById(idx);
        if (e.isEmpty()) {
            throw new RuntimeException("data not found");
        }
        return e.get();
    }
}
Controller 레이어 생성
@RequiredArgsConstructor
@RestController
public class PostController {
    private final PostService service;
    @PostMapping("/api/v1/ins")
    public PostDto insert(@RequestBody PostDto dto) {
        return service.insert(dto);
    }
    @PostMapping("/api/v1/upd")
    public PostDto update(@RequestBody PostDto dto) {
        return service.update(dto);
    }
    @GetMapping("/api/v1/del")
    public void delete(@RequestParam("id") Long id) {
        service.delete(id);
    }
    @GetMapping("/api/v1/undel")
    public void undelete(@RequestParam("id") Long id) {
        service.undelete(id);
    }
    @GetMapping("/api/v1/")
    public PostDto get(@RequestParam("id") Long id) {
        return service.getOne(id);
    }
}
테스트
VSCode 에 Thunder Client 플러그인을 설치하면 API 를 호출할 수 있습니다.
list
다른 API 와 다르게 생각해야 할 부분이 많지만,
페이징을 구현하고, 검색조건은 없거나 1나의 검색조건을 구현합니다.

Spring Boot 게시판 생성하기

댓글