[Web_3] Spring 7 😴

📌 JDBC
📌 마이바티스 MyBatis
📌 SpringBoot 프로젝트 DB 연결
📌 Request 데이터 DB Insert : News POST
🦎 마이바티스 : useGeneratedKeys
🦎 마이바티스 : resultMap

💡 JDBC (Java Database Connectivity)

자바 프로그램이 데이터베이스에 접속할 수 있도록 하는 자바 내 API

Connection 객체를 생성해 자바 프로그램을 데이터베이스와 연결한다.

💡 SpringBoot JDBC

JdbcTemplate
스프링에서 기본적으로 제공해주는 JDBC 라이브러리
JdbcTemplate을 사용하려면 @Autowired로 bean 등록을 해주면 된다.

💡 마이바티스 MyBatis

직접 JDBC를 이용하는 것이 기존 방식 ... 그러나 SQL 쿼리가 프로그램에 바로 작성되어 있어 복잡하고 반복되는 코드가 많음.

➡️ 그래서 일반적으로 마이바티스 를 사용한다.
자바 객체와 SQL 쿼리를 매핑하여 자바 프로그램과 데이터베이스와의 연결을 쉽게 할 수 있도록 하는 프레임워크

SQL 쿼리를 XML 파일 한 곳에서 작성하도록 하여 서비스 로직 코드와 분리한다.

🐼 Spring - MyBatis Project 생성

→ spring.io
압축 풀고 인텔리제이 에서 폴더 열어주면 끗

🦎 마이바티스 스프링 설정
▫️ application.yml

server:
  port: 8000

spring:
  datasource:
    driver-class-name: org.mariadb.jdbc.Driver
    url: jdbc:mariadb:// ...
    username: ...
    password: ...
    
📍
mybatis:
  mapper-locations:
    - /mappers/*.xml

💡 Request 데이터 DB Insert 하기 : News POST

👾 News : 기사와 첨부파일을 DB에 Insert 하기

>> java > com.boot.Project 폴더에
> controller
> controller.api ( ※ 서비스 안 만들고 컨트롤러에서 바로 서비스 로직 구현함 )
> domain
> repository

>> resource 폴더에
> mappers 만들어줌 (myBatis xml 파일 폴더)

▫️ application.yml
file 받아올 때 → multipart , file.path

server:
  port: 8000

spring:
  mvc:
    static-path-pattern: /static/**

  datasource:
    driver-class-name: org.mariadb.jdbc.Driver
    url: jdbc:mariadb://...:3306/...
    username: ...
    password: ...
 
📍servlet:
    multipart:
      max-file-size: 100MB
      max-request-size: 100MB

mybatis:
  mapper-locations:
    - /mappers/*.xml

 
file:
📍path: C:/User/user/upload/

▫️ PageController.java

@Controller
public class PageController {
    @GetMapping("/news/newpost")
    public String writeNews() {
        return "news/write"; // news 폴더의 write.html
    }
}

→ http://localhost:8000/news/newpost

▫️ NewsWriteReqDto.java

@Data
public class NewsWriteReqDto {
    private String title;
    private String writer;
    private String broadcastingName;
    private String content;
    private List<MultipartFile> files;

    public News toEntity(String writer) { // save 시 작성자를 등록
        return News.builder()
                .news_title(title)
                .news_writer(writer)
                .news_broadcasting(broadcastingName)
                .news_content(content)
                // file 은 따로 처리
                .build();
    }
}

▫️ NewsFile.java

@Builder
@NoArgsConstructor
@AllArgsConstructor
@Data
public class NewsFile {
    private int file_id;
    private int news_id;
    private String file_origin_name;
    private String file_temp_name;
}

▫️ News.java

@Builder
@NoArgsConstructor
@AllArgsConstructor
@Data
public class News {
    private int news_id;
    private String news_title;
    private String news_writer;
    private String news_broadcasting;
    private String news_content;
    private List<NewsFile> news_file;

    private LocalDateTime create_date;
    private LocalDateTime update_date;

    public NewsWriteRespDto toNewsWriteRespDto(List<NewsFile> newsFileList) {
    // 첨부파일을 따로 처리하여, 서버에서 응답 데이터를 만들어 줄 때 합쳐줌. 
        return NewsWriteRespDto.builder()
                .id(news_id)
                .title(news_title)
                .writer(news_writer)
                .broadcastingName(news_broadcasting)
                .content(news_content)
                .newsFileList(newsFileList)
                .build();
    }
}

▫️ NewsWriteRespDto.java

@Builder
@Data
public class NewsWriteRespDto {
    private int id;
    private String title;
    private String writer;
    private String broadcastingName;
    private String content;
    private List<NewsFile> newsFileList;
}

(요청) NewsWriteReqDto , NewsFile → News → (응답) NewsWriteRespDto

▫️ NewsRepository.java

@Mapper
public interface NewsRepository {
    public int save(News news);
    public int saveFiles(List<NewsFile> newsFileList);
    public News getNews(int news_id); 
    // 메소드들은 xml 파일에서 sql 문으로 구현됨. 
}

@Mapper 어노테이션이 myBatis 와 연결해서 구현된 xml 을 가지고 스프링 IoC 컨테이너의 @서비스, @레포지토리 등을 알아서 처리해줌.

▫️ news.xml

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

<mapper namespace="com.boot.mybatisProject.repository.NewsRepository">

    <resultMap id="news_file" type="com.boot.mybatisProject.domain.NewsFile">
        <result property="file_origin_name" column="file_origin_name"></result>
        <result property="file_temp_name" column="file_temp_name"></result>
    </resultMap>
  
    <resultMap id="news" type="com.boot.mybatisProject.domain.News">
        <result property="news_id" column="news_id"></result>
        <result property="news_title" column="news_title"></result>
        <result property="news_writer" column="news_writer"></result>
        <result property="news_broadcasting" column="news_broadcasting"></result>
        <result property="news_content" column="news_content"></result>
        <result property="create_date" column="create_date"></result>
        <collection property="news_file" javaType="list" resultMap="news_file"></collection>
    </resultMap>

 
  <!-- id는 메소드명과 일치해야 함 ❗ -->
  
    <insert
            id="save"
            parameterType="com.boot.mybatis20220923junil.domain.News"
            useGeneratedKeys="true"
            keyProperty="news_id"
    >
        insert into
            news_mst
        values (
            0,
            #{news_title},
            #{news_writer},
            #{news_broadcasting},
            #{news_content},
            now(),
            now()
        )
    </insert>

    <select id="getNews" resultMap="news">
        SELECT
            nm.news_id,
            nm.news_title,
            nm.news_writer,
            nm.news_broadcasting,
            nm.news_content,

            nf.file_origin_name,
            nf.file_temp_name,

            nm.create_date

        FROM
            news_mst nm
            left outer join news_file nf ON(nf.news_id = nm.news_id)
        WHERE
            nm.news_id = #{news_id};
    </select>

    <insert
            id="saveFiles"
            parameterType="java.util.List"
            useGeneratedKeys="true"
            keyProperty="file_id"
    >
        insert into
            news_file
        values
        <foreach item="newsFile" collection="newsFileList" separator=",">
            (
                0,
                #{newsFile.news_id},
                #{newsFile.file_origin_name},
                #{newsFile.file_temp_name},
                now(),
                now()
            )
        </foreach>


    </insert>
</mapper>

🦎 마이바티스 : useGeneratedKeys

자동 생성되는 값들을 사용하려면 useGeneratedKeys="true" 로 설정해야 한다. keyProperty로 값을 가져올 변수를 지정함.
➡️ 자동 생성된 news_id 값들이 가져와짐.

🦎 마이바티스 : resultMap

result(조회값) 를 객체 모델에 매핑할 수 있도록 하는 설정

DTO 객체의 필드명과 SELECT 구문의 조회 컬럼명이 일치하지 않거나, 타입이 매칭되지 않을 때 사용한다.

▫️ NewsController.java
🐼 ( 1 ) 기사 받아오기

@Slf4j
@RequestMapping("/api")
@RequiredArgsConstructor
@RestController
public class NewsController {
    
    private final NewsRepository newsRepository;

    @PostMapping("/news")
    public ResponseEntity<?> write(NewsWriteReqDto newsWriteReqDto) {
        log.info("{}", newsWriteReqDto);

        News news = newsWriteReqDto.toEntity("짱구"); // 작성자
        int result = newsRepository.save(news); // result 는 영향받은 행 수 

        if(result == 0) {
            return ResponseEntity.internalServerError().body(new CMRespDto<>(-1, "새 글 작성 실패", news));
        }

        return ResponseEntity.ok(new CMRespDto<>(1, "새 글 작성 완료", newsWriteRespDto));
    }

🐼 ( 2 ) 첨부파일 받아오기

@Slf4j
@RequestMapping("/api")
@RequiredArgsConstructor
@RestController
public class NewsController {

    @Value("${file.path}") 
    // ➡️ NewsController가 생성될 때 변수에 Value가 주입됨. (application.yml에서 값을 가져와 주입)
    // ✔️ application.yml 에서 모든 경로를 관리함.
    private String filePath;
    private final NewsRepository newsRepository;

    @PostMapping("/news")
    public ResponseEntity<?> write(NewsWriteReqDto newsWriteReqDto) {
        log.info("{}", newsWriteReqDto);

		// ⭐ 첨부파일 받아오기 
        List<NewsFile> newsFileList = null;

		// (1) 클라이언트에서 보낸 첫번째[인덱스:0] 첨부파일을 가져옴
        MultipartFile firstFile = newsWriteReqDto.getFiles().get(0);
        String firstFileName = firstFile.getOriginalFilename();
		
        // 0번 인덱스 첨부파일이 빈 값이 아님 ➡️ POST 요청한 파일이 존재
        if(!firstFileName.isBlank()) {
            log.info("첨부파일을 가져옵니다.");

            newsFileList = new ArrayList<NewsFile>();

            for(MultipartFile file : newsWriteReqDto.getFiles()){
                String originFileName = file.getOriginalFilename();
				
                // file RandomUUID 이름 생성 (파일명이 겹치지 않도록 하기 위함) 
                // extension : 파일 확장자명
                String uuid = UUID.randomUUID().toString();
                String extension = originFileName.substring(originFileName.lastIndexOf("."));
                String tempFileName = uuid + extension; 

                Path uploadPath = Paths.get(filePath, "news/" + tempFileName);
				
                // filePath 경로에 news 폴더가 존재하지 않으면 만들어줌. 
                File f = new File(filePath + "news");
                if(!f.exists()) {
                    f.mkdirs(); // make directory
                }

				// 미리 지정해둔 파일 경로에 실제 파일 데이터 덮어쓰기함❗
                try {
                    Files.write(uploadPath, file.getBytes());
                } catch (IOException e) {
                    throw new RuntimeException(e);
                }

                NewsFile newsFile = NewsFile.builder()
                        .file_origin_name(originFileName)
                        .file_temp_name(tempFileName)
                        .build();

                newsFileList.add(newsFile);
            }
        }

		// ⭐ 기사 받아오기
        News news = newsWriteReqDto.toEntity("짱구"); // 작성자
        // 기사 DB insert 해줌. 
        int result = newsRepository.save(news); // result 는 영향받은 행 수

        if(result == 0) {
            return ResponseEntity.internalServerError().body(new CMRespDto<>(-1, "포스팅 실패", news));
        }

		// 업로드할 파일이 존재하면 따로 DB Insert 해줌. 
        if(newsFileList != null) {
            for(NewsFile newsFile : newsFileList) {
                newsFile.setNews_id(news.getNews_id()); // news.xml 에서 useGenerate 로 id 값을 가져올 수 있음. 
                log.info("NewsFile 객체: {}", newsFile);
            }
            result = newsRepository.saveFiles(newsFileList);

            if(result != newsFileList.size()) {
                return ResponseEntity.internalServerError().body(new CMRespDto<>(-1, "파일 업로드 실패", newsFileList));
            }
        }
        
        // ⭐ 기사 + 첨부파일 DB insert 완료 ➡️ 응답 데이터 생성

        NewsWriteRespDto newsWriteRespDto = news.toNewsWriteRespDto(newsFileList);

        return ResponseEntity.ok(new CMRespDto<>(1, "포스팅 완료", newsWriteRespDto));
    }

}

서버에서의 파일 다운로드

• 파일의 유일한 이름을 생성함. (겹치지 않도록 하기 위함)
• 저장공간에 파일 이름으로 업로드 경로를 설정하여 빈 파일으로 둠.
  ( ※ 경로에는 확장자까지 필요함 )
• 미리 지정해 둔 파일 경로(빈 파일)에 파일 데이터(byte)를 덮어씌우도록 함.

📢 소감 😴
인간이 가장 불행하다는 일요일 저녁 7시
나는 너무너무 불행해서 아이스크림을 먹을 수 밖에 업었다
요즘에는 칙촉 아이스크림에 완전 빠져있씀