MyBatis

MyBatis 대해서 알아보고 간단하게 게시판 기능을 구현하는 실습까지 진행해 보도록 하겠습니다.

•

Mybatis

•

프로젝트 구조

•

스프링 부트에서 MyBatis 사용

•

의존성 추가

◦

build.gradle

◦

pom.xml

•

마이바티스 설정 파일 - mybatis-config.xml

•

프로젝트 설정 - application.properties

•

DB 구축

•

로직 작성

◦

DTO 작성

◦

SQL Mapper 작성

◦

Mapper 인터페이스 작성

◦

Service 작성

◦

Controller 작성

◦

View 작성

MyBatis

마이바티스는 개발자가 지정한 SQL, 저장프로시저 그리고 몇가지 고급 매핑을 지원하는 퍼시스턴스 프레임워크이다.

자바 프로그램에서 데이터베이스 연동을 위해서, JDBC 드라이버를 사용하면, Java 코드와 SQL 코드가 같이 사용되니까, 유지보수성이 저하됩니다.

그래서 Mybatis 를 사용하면, Java 코드에서 SQL 을 분리해서 XML 관리를 하고, 자바의 인터페이스 호출에 따라서 XML 의 특정 id 에 해당하는 쿼리를 실행시큰 SQL Mapper 방식으로 DB 연동을 할 수 있습니다.

프로젝트 구조

📦 spring-mybatis
│
└───📂java
│   └───📂com.aloha.springmybatis
│       │
│       ├───📂controller
│       │   └───📄BoardController.java
│       │
│       ├───📂dto
│       │   └───📄Board.java
│       │
│       ├───📂service
│       │   │
│       │   ├───📄BoardService.java
│       │   └───📄BoardServiceImpl.java
│       │
│       └───📂mapper
│           └───📄BoardMapper.java
│
└───📂resources
    │   📄application.properties
    │   📄mybatis-config.xml
    │
    └───📂com.aloha.springmybatis.mapper
        └────📄BoardMapper.xml
Plain Text
복사

스프링 부트에서 MyBatis 사용

SpringBoot 에서 MyBatis를 사용할 때에는 주로 Gradle 빌드도구의 설정파일은 build.gradle 또는 Maven 빌드도구의 설정 파일인 pom.xml 에 의존성을 추가하여 사용합니다

의존성 추가

•

build.gradle

•

pom.xml

build.gradle

•

mysql 드라이버 의존성

•

MyBatis 의존성

•

build.gradle 전체코드

mysql 드라이버 의존성

runtimeOnly 'com.mysql:mysql-connector-j'
Java
복사

MyBatis 의존성

implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:3.0.3'
testImplementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter-test:3.0.3'
Java
복사

springboot v3 버전을 기준으로 사용한 의존성입니다.

build.gradle

plugins {
	id 'java'
	id 'war'
	id 'org.springframework.boot' version '3.3.5'
	id 'io.spring.dependency-management' version '1.1.6'
}

group = 'com.aloha'
version = '0.0.1-SNAPSHOT'

java {
	toolchain {
		languageVersion = JavaLanguageVersion.of(17)
	}
}

configurations {
	compileOnly {
		extendsFrom annotationProcessor
	}
}

repositories {
	mavenCentral()
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
	implementation 'org.springframework.boot:spring-boot-starter-web'
	implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:3.0.3'
	compileOnly 'org.projectlombok:lombok'
	developmentOnly 'org.springframework.boot:spring-boot-devtools'
	runtimeOnly 'com.mysql:mysql-connector-j'
	annotationProcessor 'org.projectlombok:lombok'
	providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
	testImplementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter-test:3.0.3'
	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
}

tasks.named('test') {
	useJUnitPlatform()
}
Java
복사

pom.xml

•

mysql 드라이버 의존성

•

MyBatis 의존성

•

build.gradle 전체코드

mysql 드라이버 의존성

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.27</version>
    <scope>runtime</scope>
</dependency>
XML
복사

MyBatis 의존성

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>3.0.3</version>
</dependency>

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter-test</artifactId>
    <version>3.0.3</version>
    <scope>test</scope>
</dependency>
XML
복사

springboot v3 버전을 기준으로 사용한 의존성입니다.

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>3.3.5</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>demo</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>war</packaging>
	<name>mybatis</name>
	<description>Demo project for Spring Boot</description>
	<url/>
	<licenses>
		<license/>
	</licenses>
	<developers>
		<developer/>
	</developers>
	<scm>
		<connection/>
		<developerConnection/>
		<tag/>
		<url/>
	</scm>
	<properties>
		<java.version>17</java.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.mybatis.spring.boot</groupId>
			<artifactId>mybatis-spring-boot-starter</artifactId>
			<version>3.0.3</version>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-devtools</artifactId>
			<scope>runtime</scope>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>com.mysql</groupId>
			<artifactId>mysql-connector-j</artifactId>
			<scope>runtime</scope>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-tomcat</artifactId>
			<scope>provided</scope>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>org.mybatis.spring.boot</groupId>
			<artifactId>mybatis-spring-boot-starter-test</artifactId>
			<version>3.0.3</version>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<configuration>
					<excludes>
						<exclude>
							<groupId>org.projectlombok</groupId>
							<artifactId>lombok</artifactId>
						</exclude>
					</excludes>
				</configuration>
			</plugin>
		</plugins>
	</build>

</project>
XML
복사

마이바티스 설정 파일 - mybatis-config.xml

mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "https://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>

	<!-- 설정 -->
	<settings>
		<!-- 언더스코어 케이스인 컬럼을 카멜 케이스로 변환하는 설정  -->
		<!-- board_no - boardNo -->
		<setting name="mapUnderscoreToCamelCase" value="true"/>
	</settings>
	
	<!-- 타입 별칭 설정 -->
	<typeAliases>
		<!-- 테이블과 매핑할 DTO가 있는 패키지 경로 지정 -->
		<package name="com.aloha.mybatis.dto"/>
	</typeAliases>	


</configuration>
XML
복사

mapUnderscoreToCamelCase

<settings>
		<!-- 언더스코어 케이스인 컬럼을 카멜 케이스로 변환하는 설정  -->
		<!-- board_no - boardNo -->
		<setting name="mapUnderscoreToCamelCase" value="true"/>
	</settings>
XML
복사

언더스코어 케이스(스네이크 케이스)를 카멜 케이스로 자동 변환해주는 기능 활성화

이렇게 작성하면 데이터베이스의 언더스코어 케이스를 별도로 자바의 카멜 케이스로 변환하지 않아도 자동으로 테이블의 컬럼명을 객체의 변수로 매핑 할 수 있게 변환해줍니다.

typeAliases - package

<typeAliases>
	<!-- 테이블과 매핑할 DTO가 있는 패키지 경로 지정 -->
	<package name="com.aloha.mybatis.dto"/>
</typeAliases>	
XML
복사

resultType 속성에서 dto 객체 (패키지.클래스명) (클래스명)

이 설정을 구성하면 Mapper 파일에서 resultType 속성이 패키지부터 클래스까지 다 지정하지 않아도, 매핑할 객체가 있는 패키지를 여기 설정함으로써, 객체 이름만 작성해도 조회의 결과를 객체의 바로 매핑할 수 있습니다.

<!-- 게시글 조회 -->
<select id="select" resultType="com.aloha.mybatis.dto.Board">
XML
복사

이 설정을 사용하지 않으면 다음과 같이 패키지부터 클래스명까지 resultType 속성에 다 작성해야 되지만, 이 설정을 사용하면 객체명만 작성해도 됩니다.

<!-- 게시글 조회 -->
<select id="select" resultType="Board">
XML
복사

따라서 조회 결과를 매핑할 객체들이 있는 패키지들을 미리 지정해 놓으면 . 다음과 같이 간결하게 속성 값을 작성할 수 있습니다 .

프로젝트 설정 - application.properties

DB 드라이버와 MyBatis의 설정을 프로젝트에 알려주기 위해서는 application.properties 파일에 다음과 같이 데이터 소스와 Mybatis 관련 설정을 작성해야 합니다.

application.properties 는 스프링 부트의 프로젝트 설정 파일입니다.

•

데이터 소스 설정

•

mybatis-config.xml 설정

데이터 소스 설정

# 데이터 소스 - MySQL
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/aloha?serverTimezone=Asia/Seoul&allowPublicKeyRetrieval=true&useSSL=false&autoReconnection=true&autoReconnection=true
spring.datasource.username=aloha
spring.datasource.password=123456
Plain Text
복사

mybatis-config.xml 설정

# Mybatis 설정
# Mybatis 설정 경로      : ~/resources/mybatis-config.xml
mybatis.config-location=classpath:mybatis-config.xml

# Mybatis 매퍼 파일 경로 : ~/메인패키지/mapper/**Mapper.xml
mybatis.mapper-locations=classpath:mybatis/mapper/**/**.xml
Plain Text
복사

•

classpath:  라고 지정하면, ~/resources 경로 하위부터 경로를 지정할 수 있다.

•

classpath:mybatis/mapper/**/**.xml  라고 지정하면, ~/resources 경로부터 모든 경로의 모든 하위 파일의 확장자가 .xml 이면 마이바티스 매퍼(SQL) 파일로 인식하도록 지정한다.

mybatis-config.xml 설정 파일 없이 적용하기

# 컬럼명을 변수명으로 자동매핑 :  board_no ➡ boardNo
mybatis.configuration.map-underscore-to-camel-case=true

# resultType 속성에서 dto 객체 (패키지.클래스명) ➡ (클래스명)
mybatis.type-aliases-package=com.aloha.mybatis.dto

# Mybatis 매퍼 파일 경로 : ~/메인패키지/mapper/**Mapper.xml
mybatis.mapper-locations=classpath:mybatis/mapper/**/**.xml
Plain Text
복사

MyBatis에 설정 파일을 사용해서 마이바티스의 설정을 관리할 수도 있지만 . 기본적인 설정들을 어플리케이션 프로포티스에서 바로 설정을 할 수도 있습니다.

application.properties

spring.application.name=spring-mybatis

# 데이터 소스 - MySQL
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/aloha?serverTimezone=Asia/Seoul&allowPublicKeyRetrieval=true&useSSL=false&autoReconnection=true&autoReconnection=true
spring.datasource.username=aloha
spring.datasource.password=123456

# Mybatis 설정
# Mybatis 설정 경로      : ~/resources/mybatis-config.xml
# mybatis.config-location=classpath:mybatis-config.xml

# 컬럼명을 변수명으로 자동매핑 :  board_no ➡ boardNo
mybatis.configuration.map-underscore-to-camel-case=true
# resultType 속성에서 dto 객체 (패키지.클래스명) ➡ (클래스명)
mybatis.type-aliases-package=com.aloha.mybatis.dto

# Mybatis 매퍼 파일 경로 : ~/메인패키지/mapper/**Mapper.xml
mybatis.mapper-locations=classpath:mybatis/mapper/**/**.xml
Plain Text
복사

DB 구축

MySQL

이번 실습에서는 MySQL의 드라이버를 사용합니다 . MySQL의 설치가 필요하거나 . 기본적인 사용 방법을 알고 싶다면 위의 페이지를 참조해 주세요 .

•

스키마 : aloha

•

테이블 생성

◦

board

board

CREATE TABLE `board` (
  `no` int NOT NULL AUTO_INCREMENT,
  `title` varchar(100) NOT NULL,
  `writer` varchar(100) NOT NULL,
  `content` text,
  `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `views` int NOT NULL DEFAULT '0',
  PRIMARY KEY (`no`)
) COMMENT='게시판';
SQL
복사

로직 작성

•

DTO 작성

•

SQL Mapper 작성

•

Mapper 인터페이스 작성

•

Service 작성

•

Controller 작성

•

View 작성

DTO 작성

•

Board.java

Board.java

Board dto는 데이터베이스의 board 테이블과 매핑하기 위한 데이터 전송 객체입니다

/**
 * Board 
 * - 게시글 정보
 */
@Data
public class Board {
    private int no;        
    private String title;
    private String writer;
    private String content;
    private Date createdAt;
    private Date updatedAt;
    private int views;
}
 
Java
복사

SQL Mapper 작성

SQL Mapper에는 데이터베이스의 요청을 보내기 위한 SQL 쿼리들을 xml 태그 형식으로 정의합니다

•

기본 Mapper 파일 형식

•

기본 CRUD Mapper 파일 코드

•

BoardMapper.xml

기본 Mapper 파일 형식

Mybatis Mapper 파일에는 최상위 태그로 <mapper> 태그를 작성하고 네임스페이스 속성을 작성해서 래퍼 인터페이스의 경로를 지정합니다.

namespace="매퍼 인터페이스 경로"

namespace의 작성한 Mapper 인터페이스의 경로가 인터페이스 파일의 경로와 일치 해야합니다.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<!-- namespace="매퍼 인터페이스 경로" --> 
<mapper namespace="com.aloha.mybatis.mapper.XXXMapper">


</mapper>
XML
복사

기본 CRUD Mapper 파일 코드

SQL 태그 <select id="select" resultType="base"> Mapper 인터페이스 메소드 public Base select(int baseNo) throws Exception;

각 SQL 태그의 id 속성값이 Mapper 인터페이스의 메소드 명과 일치해야합니다.

로직을 통해서 Mapper 인터페이스의 메소드가 호출이 되면, 이와 매핑되어 있는 SQL mapper 파일의 해당 메소드명과 일치하는 아이디를 가진 SQL 태그가 실행됩니다

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<!-- namespace="매퍼 인터페이스 경로" -->
<mapper namespace="com.aloha.mybatis.mapper.BaseMapper">
   
    <!-- 기본 등록 -->
    <insert id="insert">
        INSERT INTO base( base_id, base_name )
        VALUES ( #{baseId}, #{baseName} )
    </insert>

    <!-- 기본 조회 -->
    <select id="select" resultType="base">
        SELECT *
        FROM base
        WHERE base_no = #{baseNo}
    </select>

    <!-- 기본 수정 -->
    <update id="update">
        UPDATE base
           SET base_id = #{baseId}
              ,base_name = #{baseName}
        WHERE base_no = #{baseNo}
    </update>


    <!-- 기본 수정 -->
    <delete id="delete">
        DELETE FROM base
        WHERE base_no = #{baseNo}
    </delete>

</mapper>
XML
복사

BoardMapper.xml

이번 실습에서는 게시글 데이터를 기본적으로 등록 조회 수정 삭제하는 쿼리들을 다음과 같이 SQL 태그로 작성해 봅니다.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<!-- namespace="매퍼 인터페이스 경로" --> 
<mapper namespace="com.aloha.mybatis.mapper.BoardMapper">
    <!-- 게시글 목록 -->
    <select id="list" resultType="Board">
        SELECT *
        FROM board
        ORDER BY created_at DESC
    </select>

    <!-- 게시글 조회 -->
    <select id="select" resultType="Board">
        SELECT *
        FROM board
        WHERE no = #{no}
    </select>

    <!-- 게시글 등록 -->
    <insert id="insert">
        INSERT INTO board( title, writer, content)
        VALUES ( #{title}, #{writer}, #{content} )
    </insert>

    <!-- 게시글 수정 -->
    <update id="update">
        UPDATE board
           SET title = #{title}
              ,writer = #{writer}
              ,content = #{content}
        WHERE no = #{no}
    </update>

    <!-- 게시글 삭제 -->
    <delete id="delete">
        DELETE FROM board
        WHERE no = #{no}
    </delete>

    <!-- 게시글 번호 최댓값 -->
    <select id="maxPk" resultType="int">
        SELECT MAX(no)
        FROM board
    </select>
</mapper>
XML
복사

Mapper 인터페이스 작성

마이바티스 매퍼 인터페이스의 메소드명은 매퍼 파일의 id 속성값과 일치해야한다. - 해당 메소드가 호출되면, 매퍼 XML 파일의 SQL를 실행한다.

•

BoardMapper.java

BoardMapper.java

@Mapper
public interface BoardMapper {

    // 게시글 목록
    public List<Board> list() throws Exception;
    // 게시글 조회
    public Board select(int no) throws Exception;
    // 게시글 등록
    public int insert(Board board) throws Exception;
    // 게시글 수정
    public int update(Board board) throws Exception;
    // 게시글 삭제
    public int delete(int no) throws Exception;
    
    // 게시글 번호(기본키) 최댓값
    public int maxPk() throws Exception;
    
}
Java
복사

매퍼 파일의 id와 일치하는 메소드명을 작성하고, 매퍼 파일의 SQL 태그에 전달해 줄 파라미터들을 매개변수로 작성합니다.

또한 조회 쿼리의 경우에는 조회 결과를 매핑 받을 객체 혹은 컬렉션을 반환 타입으로 작성하고, 등록, 수정, 삭제, 쿼리의 경우에는 데이터베이스에서 처리된 행의 수를 반환받기 위하여 int 타입으로 작성합니다

Service 작성

이제 서비스 인터페이스와 구현 클래스를 작성합니다.

•

BoardService.java

•

BoardServiceImpl.java

BoardService.java

서비스 인터페이스를 통해서 비즈니스 로직에서 사용할 기능에 대한 메소드의 형태를 정의합니다. 이렇게 인터페이스로 메소드 형태를 정의함으로써, 실제로 구현할 코드에 대해서 다형성과 확장성을 제공합니다.

public interface BoardService {

    // 게시글 목록
    public List<Board> list() throws Exception;
    // 게시글 조회
    public Board select(int no) throws Exception;
    // 게시글 등록
    public int insert(Board board) throws Exception;
    // 게시글 수정
    public int update(Board board) throws Exception;
    // 게시글 삭제
    public int delete(int no) throws Exception;
    
}
Java
복사

BoardServiceImpl.java

구현 클래스에서는 매퍼 인터페이스의 적절한 메소드로 호출함으로써 데이터에 대하여 조회, 등록, 수정, 삭제 요청을 보낼 수 있도록 코드를 완성합니다. 또한 각 메소드에서는 서비스의 각 기능에 대한 추가 로직을 확장하거나 관련된 로그 및 처리들을 할 수 있습니다.

@Service    // 서비스 역할의 스프링 빈
public class BoardServiceImpl implements BoardService {
    
    @Autowired
    private BoardMapper boardMapper;

    /**
     * 게시글 목록 조회
     */
    @Override
    public List<Board> list() throws Exception {
        // TODO : boardMapper 로 list() 호출
        /*
         *        ➡ List<Board> boardList 로 받아옴
         *        ➡ return boardList
         */
        List<Board> boardList = boardMapper.list();
        return boardList;
    }

    /**
     * 게시글 조회
     * - no 매개변수로 게시글 번호를 전달받아서
     *   데이터베이스에 조회 요청
     */
    @Override
    public Board select(int no) throws Exception {
        // TODO : boardMapper 로 select(no) 호출
        /*
         *        ➡ Board board 로 받아옴
         *        ➡ return board
         */
        Board board = boardMapper.select(no);
        return board;        
    }

    /**
     * 게시글 등록
     */
    @Override
    public int insert(Board board) throws Exception {
        // TODO : boardMapper 로 insert(Board) 호출
        /*
        *        ➡ int result 로 데이터 처리 행(개수) 받아옴
        *        ➡ return result
        */
        int result = boardMapper.insert(board);
        return result;
    }

    /**
     * 게시글 수정
     */
    @Override
    public int update(Board board) throws Exception {
        // TODO : boardMapper 로 update(Board) 호출
        /*
         *        ➡ int result 로 데이터 처리 행(개수) 받아옴
         *        ➡ return result
         */
        int result = boardMapper.update(board);
        return result;
    }

    /**
     * 게시글 삭제
     */
    @Override
    public int delete(int no) throws Exception {
        // TODO : boardMapper 로 delete(no) 호출
        /*
         *        ➡ int result 로 데이터 처리 행(개수) 받아옴
         *        ➡ return result
         */
        int result = boardMapper.delete(no);
        return result;
    }


}
Java
복사

Controller 작성

컨트롤러에서는 요청 경로를 매핑하여 클라이언트에 요청에 대하여 적절한 서비스 로직 및 데이터를 처리하고, 클라이언트에게 응답할 뷰 페이지를 지정합니다.

요청 경로 매핑

데이터 요청

뷰 페이지 지정

BoardController.java

package com.aloha.mybatis.controller;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

import com.aloha.springmybatis.dto.Board;
import com.aloha.springmybatis.service.BoardService;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.RequestBody;





/**
 *  /board 경로로 요청 왔을 때 처리
 *  [GET]   - /board/list   : 게시글 목록 화면
 *  [GET]   - /board/read   : 게시글 조회 화면
 *  [GET]   - /board/insert : 게시글 등록 화면
 *  [POST]  - /board/insert : 게시글 등록 처리
 *  [GET]   - /board/update : 게시글 수정 화면
 *  [POST]  - /board/update : 게시글 수정 처리
 *  [POST]  - /board/delete : 게시글 삭제 처리
 */
@Slf4j                      // 로그 어노테이션
@Controller                 // 컨트롤러 스프링 빈으로 등록
@RequestMapping("/board")   // 클레스 레벨 요청 경로 매핑 
                            // - /board/~ 경로의 요청은 이 컨트롤러에서 처리
public class BoardController {
    
    // ⭐데이터 요청과 화면 출력
    // Controller --> Service (데이터 요청)
    // Controller <-- Service (데이터 전달)
    // Controller --> Model   (모델 등록)
    // View <-- Model         (데이터 출력)
    @Autowired                              // 의존성 자동 주입
    private BoardService boardService;      // @Service를 --Impl 에 등록

    /**
     * 게시글 목록 조회 화면
     * @return
     * @throws Exception 
     */
    @GetMapping("/list")
    public String list(Model model) throws Exception {
        // 데이터 요청
        List<Board> boardList = boardService.list();
        // 모델 등록
        model.addAttribute("boardList", boardList);
        // 뷰 페이지 지정
        return "/board/list";       // resources/templates/board/list.html
    }
    
    /**
     * 게시글 조회 화면
     * - /board/read?no=💎
     * @param no
     * @return
     * @throws Exception 
     */
    // @RequestParam("파라미터명") 
    // - 스프링 부트 3.2버전 이하, 생략해도 자동 매핑된다.
    // - 스프링 부트 3.2버전 이상, 필수로 명시해야 매핑된다.
    @GetMapping("/read")
    public String read(@RequestParam("no") int no, Model model) throws Exception {
        // 데이터 요청
        Board board = boardService.select(no);
        // 모델 등록
        model.addAttribute("board", board);
        // 뷰페이지 지정
        return "/board/read";
    }
    
    /**
     * 게시글 등록 화면
     * @return
     */
    @GetMapping("/insert")
    public String insert() {

        return "/board/insert";
    }

    /**
     * 게시글 등록 처리
     * @param board
     * @return
     * @throws Exception 
     */
    @PostMapping("/insert")
    public String insertPro(Board board) throws Exception {
        // 데이터 요청
        int result = boardService.insert(board);
        // 리다이렉트
        // ⭕ 데이터 처리 성공
        if( result > 0 ) {
            return "redirect:/board/list";
        }
        // ❌ 데이터 처리 실패
        return "redirect:/board/insert?error";  
    }
    
    /**
     * 게시글 수정 화면
     * @param no
     * @param model
     * @return
     * @throws Exception 
     */
    @GetMapping("/update")
    public String update(@RequestParam("no") int no, Model model) throws Exception {
        Board board = boardService.select(no);
        model.addAttribute("board", board);
        return "/board/update";
    }

    /**
     * 게시글 수정 처리
     * @param board
     * @return
     * @throws Exception
     */
    @PostMapping("/update")
    public String updatePro(Board board) throws Exception {
        int result = boardService.update(board);

        if( result > 0 ) {
            return "redirect:/board/list";
        }
        int no = board.getNo();
        return "redirect:/board/update?no="+ no + "&error";
    }
    
    /**
     * 게시글 삭제 처리
     * @param no
     * @return
     * @throws Exception
     */
    @PostMapping("/delete")
    public String delete(@RequestParam("no") int no) throws Exception {
        int result = boardService.delete(no);
        if( result > 0 ) {
            return "redirect:/board/list";
        }
        return "redirect:/board/update?no=" + no + "&error";
    }
    
    
}
Java
복사

View 작성

•

board

◦

list.html

◦

insert.html

◦

read.html

◦

update.html

•

index.html

index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>메인 화면</title>
</head>
<body>
    <h1>SpringBoot x MyBatis</h1>    
    <h3>게시판 프로젝트</h3>
    <ul>
        <li>Spring Boot 3.x</li>
        <li>Thymeleaf</li>
        <li>MySQL 8.x</li>
        <li>MyBatis 3.0</li>
    </ul>
    <div>
        <a href="/board/list">게시판</a>
    </div>
</body>
</html>
HTML
복사

•

board

list.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>게시글 목록</title>
</head>
<body>
    <h1>게시글 목록</h1>
    <a href="/board/insert">글쓰기</a>
    <table border="1">
        <tr>
            <th width="50">번호</th>
            <th width="300">제목</th>
            <th width="100">작성자</th>
            <th width="200">등록일자</th>
            <th width="200">수정일자</th>
            <th widht="100">조회수</th>
        </tr>
        <th:block th:each="board : ${boardList}">
            <tr>
                <td align="center" th:text="${board.no}"></td>
                <td>
                    <!-- th:???="|문자열+${표현식}|" -->
                    <a th:href="|/board/read?no=${board.no}|" 
                    th:text="${board.title}"></a>
                </td>
                <td align="center" th:text="${board.writer}"></td>
                <!-- 
                    유틸리티객체.메소드()
                    #dates.format( 날짜객체명, '날짜포맷' ) 
                    - #dates.format( board.regDate, 'yyyy-MM-dd HH:mm:ss' )
                -->
                <td align="center">
                    <span th:text="${ #dates.format( board.createdAt, 'yyyy-MM-dd HH:mm:ss' ) }"></span>
                </td>
                <td align="center">
                    <span th:text="${ #dates.format( board.updatedAt, 'yyyy-MM-dd HH:mm:ss' ) }"></span>
                </td>
                <td align="center" th:text="${board.views}"></td>
            </tr>
        </th:block>
    </table>

    
</body>
</html>
HTML
복사

insert.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>게시글 등록</title>
</head>
<body>
    <h1>게시글 등록</h1>

    <form action="/board/insert" method="post">
        <input type="text" name="title" id="title">
        <input type="text" name="writer" id="writer">
        <input type="text" name="content" id="content">
        <input type="submit" value="등록">
    </form>
</body>
</html>
HTML
복사

read.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>게시글 조회</title>
</head>
<body>
    <h1>게시글 조회</h1>

    <form action="/board/delete" method="post">
        <input type="hidden" name="no" th:value="${board.no}">
        <table>
            <tr>
                <td>제목</td>
                <td>
                    <input type="text" name="title" th:value="${board.title}">
                </td>
            </tr>
            <tr>
                <td>작성자</td>
                <td>
                    <input type="text" name="writer" th:value="${board.writer}">
                </td>
            </tr>
            <tr>
                <td colspan="2">
                    <textarea name="content" id="content" cols="40" rows="5"
                              th:text="${board.content}"></textarea>
                </td>
            </tr>
        </table>
        <div>
            <button type="button" onclick="moveUpdate()">수정</button>
            <button type="button" onclick="moveList()">목록</button>
        </div>
    </form>

    <script>

        // 👩‍💻 모델 객체를 자바스크립트로 가져오는 방법
        let no = "[[${board.no}]]"

        // 수정 화면 이동
        function moveUpdate() {
            location.href = '/board/update?no=' + no
        }

        // 목록 화면 이동
        function moveList() {
            location.href = '/board/list'
        }
    </script>
</body>
</html>
HTML
복사

update.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>게시글 수정</title>
</head>
<body>
    <h1>게시글 수정</h1>

    <form id="form" action="/board/update" method="post">
        <input type="hidden" name="no" th:value="${board.no}">

        <table>
            <tr>
                <td>제목</td>
                <td>
                    <input type="text" name="title" th:value="${board.title}">
                </td>
            </tr>
            <tr>
                <td>작성자</td>
                <td>
                    <input type="text" name="writer" th:value="${board.writer}">
                </td>
            </tr>
            <tr>
                <td colspan="2">
                    <textarea name="content" id="content" cols="40" rows="5"
                              th:text="${board.content}"></textarea>
                </td>
            </tr>
        </table>
        <div>
            <button type="submit">수정</button>
            <button type="button" onclick="actionDelete()">삭제</button>
            <button type="button" onclick="moveList()">목록</button>
        </div>
    </form>

    <script>
        let form = document.getElementById('form')

        // 👩‍💻 모델 객체를 자바스크립트로 가져오는 방법
        let no = "[[${board.no}]]"
        
        // 수정 화면 이동
        function moveUpdate() {
            location.href = '/board/update?no=' + no
        }
 
        // 삭제 요청
        function actionDelete() {
            let check = confirm('정말로 삭제하시겠습니까?')
            if( check ) {
                form.action = '/board/delete'
                form.submit()
            }
        }

        // 목록 화면 이동
        function moveList() {
            location.href = '/board/list'
        }
    </script>
</body>
</html>
HTML
복사

기능 명세서

•

게시글 등록

•

게시글 목록 조회

•

게시글 조회

•

게시글 수정

•

게시글 삭제

게시글 등록

게시글 등록 시, 사용자가 /board/insert.html 에서 게시글 정보 (제목, 작성자, 내용)를 입력하고, 여러 파일을 첨부하여 요청한다.

•

게시글 정보 등록

•

파일 업로드

게시글 정보 등록

•

Model

◦

BoardService.java

▪

insert(Board)

◦

BoardServiceImpl.java

▪

insert(Board)

•

게시글 정보 등록

◦

BoardMapper 의 insert(Board) 호출

•

파일 업로드

◦

FileService 의 upload(List<Files>) 호출

◦

BoardMapper.java

▪

insert(Board)

•

BoardMapper.xml 의 id=”insert” 쿼리와 연결

◦

BoardMapper.xml

▪

<insert id=”insert” … >

•

적용된 데이터 행의 수를 반환 ( 0 또는 1 )

•

View

◦

~/board/insert.html

▪

[POST] 방식으로 FORM 요청

•

파라미터 

◦

제목 : title

◦

작성자 : writer

◦

내용 : content

◦

파일 : file

•

Controller

◦

BoardController.java

▪

@GetMapping(”/board/insert”)

•

응답

◦

/board/insert

▪

@PostMapping(”/board/insert”)

•

@RequestBody Board board

•

BoardService 의 insert() 메소드 요청

•

응답

◦

 요청 성공 : (redirect)  /board/list

◦

 요청 실패 : (redirect)  /board/insert?error

게시글 목록 조회

게시글 의 전체 목록을 조회합니다.

•

게시글 목록 전체 조회

게시글 목록 - MVC

•

Model : BoardService

•

View : /board/list.html

•

Controller : BoardController.java

게시글 목록 조회

•

Model

◦

BoardService.java

▪

list()

◦

BoardServiceImpl.java

▪

list()

◦

BoardMapper.java

▪

list()

•

BoardMapper.xml 의 id=”list” 쿼리와 연결

◦

BoardMapper.xml

▪

<seledct id=”list” resultType=”Board” … >

•

resultType=”Board”

◦

 조회된 board 테이블을 Board 객체로 매핑

•

View

◦

~/board/list.html

•

Controller

◦

BoardController.java

▪

@GetMapping(”/board/list”)

•

Model  boardList

•

응답

◦

/board/list

게시글 조회

게시글 정보 한 건을 조회합니다.

•

게시글 정보 조회

•

첨부 파일 목록 조회

게시글 정보 조회

•

Model

◦

BoardService.java

▪

select(no)

◦

BoardServiceImpl.java

▪

select(no)

◦

BoardMapper.java

▪

select(no)

•

BoardMapper.xml 의 id=”select” 쿼리와 연결

◦

BoardMapper.xml

▪

<seledct id=”select” resultType=”Board” … >

•

resultType=”Board”

◦

 조회된 board 테이블을 Board 객체로 매핑

•

View

◦

~/board/read.html

•

Controller

◦

BoardController.java

▪

@GetMapping(”/board/read”)

•

Model  board

•

응답

◦

/board/read

게시글 수정

게시글 정보 한 건을 수정합니다.

•

게시글 정보 수정

•

파일 삭제 (AJAX)

게시글 정보 수정

•

Model

◦

BoardService.java

▪

update(board)

◦

BoardServiceImpl.java

▪

update(board)

◦

BoardMapper.java

▪

update(board)

•

BoardMapper.xml 의 id=”update” 쿼리와 연결

◦

BoardMapper.xml

▪

<update id=”update” … >

•

적용된 데이터 행의 수를 반환 ( 0 또는 1 )

•

View

◦

~/board/update.html

•

Controller

◦

BoardController.java

▪

@GetMapping(”/board/update”)

•

Model  board

•

응답

◦

/board/update

▪

@PostMapping(”/board/update”)

•

@RequestBody Board board

•

BoardService 의 update() 메소드 요청

•

응답

◦

 요청 성공 : (redirect)  /board/list

◦

 요청 실패 : (redirect)  /board/update?error

게시글 삭제

게시글 정보 한 건을 삭제합니다.

•

게시글 삭제

•

첨부 파일 삭제

게시글 삭제

•

Model

◦

BoardService.java

▪

delete(no)

◦

BoardServiceImpl.java

▪

delete(no)

◦

BoardMapper.java

▪

delete(no)

•

BoardMapper.xml 의 id=”delete” 쿼리와 연결

◦

BoardMapper.xml

▪

<delete id=”delete” … >

•

적용된 데이터 행의 수를 반환 ( 0 또는 1 )

•

View

◦

~/board/update.html 에서 [삭제] 버튼으로 요청

•

Controller

◦

BoardController.java

▪

@GetMapping

•

▪

@PostMapping(”/board/delete”)

•

@RequestBody Board board

•

BoardService 의 delete() 메소드 요청

•

응답

◦

 요청 성공 : (redirect)  /board/list

◦

 요청 실패 : (redirect)  /board/update?error