Hello, sbb!

$$config title: SBB 기술 설명서 keywords: - 스프링부트 - JAVA - 기술서 $$ # ?사이트 기술서 ㅤ ## ? 개요 ``` ☝ SpringBoot Framework를 통하여 자유게시판 구현 ``` ``` ✌ 회원가입 & 로그인/ 질문 작성 & 답변 기능 구현 ``` ㅤ ## ? 링크 GitHub Repository : [https://github.com/thdcodud01/springBoot](https://github.com/thdcodud01/springBoot) SBB 사이트 링크 : [https://chaeyoung.shop](https://chaeyoung.shop) ㅤ ## ✔️ 사용 기술 ### ⚓ 버전 관리 ``` - git & Github ``` ### ⚓ 배포 ``` - Github - Github Action - Docker ``` ### ⚓ 개발 환경 ``` - IntelliJ - Termius - Crome - DBeaver - MariaDB - Mac OS ``` ### ⚓ 서비스 환경 ``` - NGINX - MariaDB - Docker - CentOS7 ``` ### ⚓ 기술 스택 ``` - JAVA - SpringBoot - SpringSecurity - Lombok - Thymeleaf - MariaDB - HTML, CSS, JS - JQuery - Tailwind ``` ㅤ ### ⚓ ERD ![img](https://i.imgur.com/5UTdvZZ.png) ㅤ ## ✔️ 기능 ### ? 회원 ``` - 회원가입 - 로그인 - 로그아웃 ``` ### ? 질문하기 ``` - 질문 작성 / 수정 / 삭제 - 질문 작성시 제목 & 내용 비었을 때 알림 - 질문 추천 가능 - 질문 검색 가능 ``` ### ? 답변하기 ``` - 질문에 답변 작성 가능 - 답변 수정 / 삭제 - 답변 추천 가능 - 답변 개수 조회 가능 ``` ㅤ ## ✔️ 주요 폴더 및 파일 ``` - Question : 질문 - Answer : 답변 - User : 회원 - static : css, js 파일 - template : html 파일 - build.gradle : 의존성 파일 - Dockerfile : Docker Image를 만들기 위한 설정 파일 ``` ㅤ ## ✔️ 배포구조 ``` - 커밋 ▶▶ 푸시 ▶▶ 깃헙 액션 빌드 유발 ▶▶ 빌드 ▶▶ 태그 생성 ▶▶도커 이미지 빌드와 푸시 ▶▶ 도커 배포 ``` ㅤ ## ✔️ 요구사항 ### ? 요구사항 분석표 | RQ-ID | 화면명 | 요구사항명| 요구사항내용 | 날짜 | 작성자 | 진행사항 | 버전명 | | --- | -- | --- | --- | --- | -- | --- | --- | | RQ-0001 | 공통 | 내비게이션바 | SBB로고, 로그인, 회원가입 버튼이 모든 페이지의 상단에 위치한다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0002 | 공통 | 내비게이션바 | SBB로고 선택시 메인페이지(질문 목록)으로 이동한다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0003 | 공통 | 내비게이션바 | 로그인 상태에 따라 로그인/로그아웃 버튼이 전환된다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0004 | 회원 | 회원가입 | 아이디, 비밀번호, 비밀번호 확인, 이메일 입력란이 있다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0005 | 회원 | 회원가입 | 입력란이 공백이거나 중복, 비밀번호 오류 발생 시 알림이 표시된다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0006 | 회원 | 로그인 | 아이디, 비밀번호 입력란과 로그인 버튼이 표시된다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0007 | 회원 | 로그인 | 아이디, 비밀번호 오류시 알림이 표시된다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0008 | 질문 페이지 | 질문 목록 | 작성된 질문의 번호, 제목, 댓글 개수, 작성자, 작성일시를 조회할 수 있다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0009 | 질문 페이지 | 질문 목록 | 질문 제목 클릭 시 해당 질문 상세 페이지로 이동한다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0010 | 질문 페이지 | 질문 목록 | 로그인 한 사용자는 질문 등록 버튼 클릭시 질문 등록 폼으로 이동한다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0011 | 질문 페이지 | 질문 목록 | 로그인 하지 않은 사용자는 질문 등록 버튼 클릭시 로그인페이지로 이동한다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0012 | 질문 페이지 | 질문 목록 | 한 화면에 질문이 10개 씩 조회되고 페이지네이션이 있다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0013 | 질문 페이지 | 질문 목록 | 질문 검색 기능이 있다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0014 | 질문 페이지 | 질문 상세 | 질문 제목, 내용, 작성자, 작성일시, 추천 버튼, 추천 개수를 조회할 수 있다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0015 | 질문 페이지 | 질문 상세 | 질문 작성자는 질문 수정, 삭제 버튼이 조회된다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0016 | 질문 페이지 | 질문 상세 | 질문 수정 버튼 선택 시 수정 폼으로 이동한다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0017 | 질문 페이지 | 질문 상세 | 질문 삭제 버튼 선택 시 알림이 표시되고 확인 선택시 질문이 삭제된다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0018 | 질문 페이지 | 질문 상세 | 로그인한 사용자는 질문 당 1번의 추천을 할 수 있다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0019 | 질문 페이지 | 질문 상세 | 로그인하지 않은 사용자는 추천 클릭 시 로그인 페이지로 이동한다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0020 | 질문 페이지 | 질문 등록 | 제목, 내용을 작성하는 입력란이 있다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0021 | 질문 페이지 | 질문 등록 | 입력란 공백시 알림이 표시된다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0022 | 질문 페이지 | 답변 | 질문 상세 페이지에 해당 질문의 답변 목록을 조회할 수 있다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0023 | 질문 페이지 | 답변 | 질문 상세 페이지에 해당 질문의 총 답변 개수를 조회할 수 있다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0024 | 질문 페이지 | 답변 | 답변 내용과 작성자, 작성일시, 수정일시, 추천 버튼, 추천 개수, 답변 작성란을 조회할 수 있다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0025 | 질문 페이지 | 답변 | 답변 작성자는 수정 , 삭제 버튼이 조회된다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0026 | 질문 페이지 | 답변 | 답변 수정 버튼 선택 시 답변 수정 폼으로 이동한다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0027 | 질문 페이지 | 답변 | 답변 삭제 버튼 선택 시 알림이 표시되고 확인 선택시 답변이 삭제된다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0028 | 질문 페이지 | 답변 | 로그인한 사용자는 답변 당 1번의 추천을 할 수 있다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0029 | 질문 페이지 | 답변 | 로그인하지 않은 사용자는 추천 클릭 시 로그인 페이지로 이동한다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0030 | 질문 페이지 | 답변 | 로그인한 사용자는 답변을 작성할 수 있다. | 5/17 | 송채영 | 반영 | 0.01 | | RQ-0031 | 질문 페이지 | 답변 | 로그인하지 않은 사용자는 답변 등록 버튼 선택시 로그인 페이지로 이동한다. | 5/17 | 송채영 | 반영 | 0.01 | ㅤ ## ✔️ Release ### ⚙️ 2023-05-17 v0.01 - 내비게이션 - 회원가입 - 로그인 - 질문 목록 - 질문 상세 - 질문 등록 - 답변 ㅤ ## ✔️ 서버 구조 ![img](https://i.imgur.com/AspJjQQ.png) ㅤ $$uml !theme mars frame 작업자PC { frame Mac OS { frame 크롬 { } } } frame 서버 { frame CentOS7 { circle CentOS7――8080 circle CentOS7――443 frame 도커 { frame npm_1 { circle npm_1――443 } frame sbb_1 { circle sbb_1――8080 } frame mariadb_1 { circle mariadb_1――3306 } } } } 크롬 --> "CentOS7――443":1． https://chaeyoung.shop 로 접속 "CentOS7――443" --> "npm_1――443" : 2． 외부(CentOS7)의 443포트는\nnpm_1의 443포트로 연결되어 있다. "npm_1――443" --> "CentOS7――8080" : 3． npm_1이 도메인(sbb.jserin.dev)을 보고\n172．17．0．1:8080 로 토스해야 겠다고 판단. "CentOS7――8080" --> "sbb_1――8080" : 4． 외부(CentOS7)의 8080포트는\nsbb_1의 8080포트로 연결되어 있다. $$ ㅤ ## ✔️ Github Action 배포순서, 테스트 실패시 $$uml !theme toy autonumber box "작업PC" actor 개발자 entity 작업PC end box entity Github_Repository box "서버" entity GithubAction entity 테스트용_서버컨테이너 entity 실서버용_서버컨테이너 end box 개발자 -> 작업PC : Commit! 작업PC -> Github_Repository : Push! Github_Repository -> GithubAction : Webhook에 의해서 Commit Signal 전송 GithubAction -> 테스트용_서버컨테이너 : 재배포 스크립트 실행 테스트용_서버컨테이너 -> GithubAction : 테스트가 실패했습니다... GithubAction -> GithubAction : 이번 빌드는 실패로 처리하고, 작업을 종료합니다. 개발자 -> GithubAction : 해당 빌드의 콘솔기록을 확인하여 테스트가 왜 실패했는지 분석 $$ ㅤ ## ✔️ Github Action 배포순서, 테스트 성공시 $$uml !theme toy autonumber box "작업PC" actor 개발자 entity 작업PC end box entity Github_Repository box "서버" entity GithubAction entity 테스트용_서버컨테이너 entity 실서버용_서버컨테이너 end box 개발자 -> 작업PC : Commit! 작업PC -> Github_Repository : Push! Github_Repository -> GithubAction : Webhook에 의해서 Commit Signal 전송 GithubAction -> 테스트용_서버컨테이너 : 재배포 스크립트 실행 테스트용_서버컨테이너 -> GithubAction : All Clear GithubAction -> 실서버용_서버컨테이너 : 리빌드 후 다시 실행하세요! 개발자 -> 실서버용_서버컨테이너 : Web Brouser로 Build 되었는지 확인 $$ ㅤ ## ✔️ 기술 설명 ### ⭐ 공통 ---- #### ? layout.html - 레이아웃이 적용된 모든 페이지에 공통 요소 출력 및 적용 ```html Hello, sbb! ``` ㅤ #### ? style.css ```css @font-face { font-family: 'KyoboHand'; src: url('https://cdn.jsdelivr.net/gh/projectnoonnu/noonfonts_20-04@1.0/KyoboHand.woff') format('woff'); font-weight: normal; font-style: normal; } * { font-family: 'KyoboHand'; font-size: 20px; } a{ text-decoration:none; color:inherit; } .table { border-bottom: 1px solid #116A7B; padding: 10px; text-color : light; } .btn { background: #CDC2AE; color: #2B3467; border-top:1px solid lightgray; border-right:1px solid lightgray; border:bottom:1px solid lightgray; } .btn:hover { background: #967E76; } .table-head { background : #C2DEDC; color:#2B3467; } .active { background : #C2DEDC; color: red; } .logoimg { width:50px; height:50px; border-radius:60px 60px; margin-right:10px; } ``` ㅤ #### ? bootstrap.min.css #### ? bootstrap.js.css - bootstrap 적용 ㅤ ### ⭐ 내비게이션바 ---- ![내비게이션바](https://i.imgur.com/OtXL4VQ.png) ![내비게이션바2](https://i.imgur.com/3rLCNoU.png) #### ? navbar.html ```html ``` ㅤ ### ⭐ 회원 ---- #### ? SiteUser.java - Entity ```java package com.ll.SBB0524.user; import jakarta.persistence.*; import lombok.Getter; import lombok.Setter; @Getter @Setter @Entity public class SiteUser { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; @Column(unique = true) private String username; private String password; @Column(unique = true) private String email; } ``` ㅤ #### ? UserRepository.java - Repository ```java package com.ll.SBB0524.user; import org.springframework.data.jpa.repository.JpaRepository; import java.util.Optional; public interface UserRepository extends JpaRepository { Optional findByusername(String username); } ``` ㅤ #### ? UserService.java - Service ```java package com.ll.SBB0524.user; import com.ll.SBB0524.DataNotFoundException; import lombok.RequiredArgsConstructor; import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder; import org.springframework.security.crypto.password.PasswordEncoder; import org.springframework.stereotype.Service; import java.util.Optional; @RequiredArgsConstructor @Service public class UserService { private final UserRepository userRepository; private final PasswordEncoder passwordEncoder; public SiteUser create(String username, String email, String password) { SiteUser user = new SiteUser(); user.setUsername(username); user.setEmail(email); user.setPassword(passwordEncoder.encode(password)); this.userRepository.save(user); return user; } public SiteUser getUser(String username) { Optional siteUser = this.userRepository.findByusername(username); if (siteUser.isPresent()) { return siteUser.get(); } else { throw new DataNotFoundException("siteuser not found"); } } } ``` ㅤ #### ? UserController.java - Controller - 로그인 / 회원가입 메소드 ```java package com.ll.SBB0524.user; import jakarta.validation.Valid; import lombok.RequiredArgsConstructor; import org.springframework.dao.DataIntegrityViolationException; import org.springframework.stereotype.Controller; import org.springframework.validation.BindingResult; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestMapping; @RequiredArgsConstructor @Controller @RequestMapping("/user") public class UserController { private final UserService userService; @GetMapping("/signup") public String signup(UserCreateForm userCreateForm) { return "signup_form"; } @PostMapping("/signup") public String signup(@Valid UserCreateForm userCreateForm, BindingResult bindingResult) { if (bindingResult.hasErrors()) { return "signup_form"; } if (!userCreateForm.getPassword1().equals(userCreateForm.getPassword2())) { bindingResult.rejectValue("password2", "passwordInCorrect", "2개의 패스워드가 일치하지 않습니다."); return "signup_form"; } try { userService.create(userCreateForm.getUsername(), userCreateForm.getEmail(), userCreateForm.getPassword1()); }catch(DataIntegrityViolationException e) { e.printStackTrace(); bindingResult.reject("signupFailed", "이미 등록된 사용자입니다."); return "signup_form"; }catch(Exception e) { e.printStackTrace(); bindingResult.reject("signupFailed", e.getMessage()); return "signup_form"; } return "redirect:/"; } @GetMapping("/login") public String login() { return "login_form"; } } ``` ㅤ #### ? UserCreateForm.java - Form - 회원가입 입력란 조건 생성 ```java package com.ll.SBB0524.user; import jakarta.validation.constraints.Email; import jakarta.validation.constraints.NotEmpty; import jakarta.validation.constraints.Size; import lombok.Getter; import lombok.Setter; @Getter @Setter public class UserCreateForm { @Size(min = 3, max = 25) @NotEmpty(message = "사용자ID는 필수항목입니다.") private String username; @NotEmpty(message = "비밀번호는 필수항목입니다.") private String password1; @NotEmpty(message = "비밀번호 확인은 필수항목입니다.") private String password2; @NotEmpty(message = "이메일은 필수항목입니다.") @Email private String email; } ``` ㅤ #### ? UserRole.java - Role - 사용자 권한 부여 ```java package com.ll.SBB0524.user; import lombok.Getter; @Getter public enum UserRole { ADMIN("ROLE_ADMIN"), USER("ROLE_USER"); UserRole(String value) { this.value = value; } private String value; } ``` ㅤ #### ? UserSecurityService.java - Service - 사용자 권환 관련 서비스 ```java package com.ll.SBB0524.user; import java.util.ArrayList; import java.util.List; import java.util.Optional; import org.springframework.security.core.GrantedAuthority; import org.springframework.security.core.authority.SimpleGrantedAuthority; import org.springframework.security.core.userdetails.User; import org.springframework.security.core.userdetails.UserDetails; import org.springframework.security.core.userdetails.UserDetailsService; import org.springframework.security.core.userdetails.UsernameNotFoundException; import org.springframework.stereotype.Service; import lombok.RequiredArgsConstructor; @RequiredArgsConstructor @Service public class UserSecurityService implements UserDetailsService { private final UserRepository userRepository; @Override public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException { Optional _siteUser = this.userRepository.findByusername(username); if (_siteUser.isEmpty()) { throw new UsernameNotFoundException("사용자를 찾을수 없습니다."); } SiteUser siteUser = _siteUser.get(); List authorities = new ArrayList<>(); if ("admin".equals(username)) { authorities.add(new SimpleGrantedAuthority(UserRole.ADMIN.getValue())); } else { authorities.add(new SimpleGrantedAuthority(UserRole.USER.getValue())); } return new User(siteUser.getUsername(), siteUser.getPassword(), authorities); } } ``` ㅤ ### ⭐ 회원가입 ---- ![회원가입](https://i.imgur.com/0RI08cT.png) #### ? signup_form.html ```html

회원가입

``` ㅤ ### ⭐ 로그인 ---- ![로그인](https://i.imgur.com/XpKlnm3.png) #### ? login_form.html ```java

``` ㅤ ### ⭐ 질문 ---- #### ? Question.java - Entity ```java package com.ll.SBB0524.question; import com.ll.SBB0524.answer.Answer; import com.ll.SBB0524.user.SiteUser; import jakarta.persistence.*; import lombok.Getter; import lombok.Setter; import java.time.LocalDateTime; import java.util.List; import java.util.Set; @Getter @Setter @Entity public class Question { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Integer id; @Column(length = 200) private String subject; @Column(columnDefinition = "TEXT") private String content; private LocalDateTime createDate; @OneToMany(mappedBy = "question", cascade = CascadeType.REMOVE, fetch = FetchType.EAGER) private List answerList; @ManyToOne private SiteUser author; private LocalDateTime modifyDate; @ManyToMany(fetch = FetchType.EAGER) Set voter; } ``` ㅤ #### ? QuestionRepository.java - Repository ```java package com.ll.SBB0524.question; import org.springframework.data.domain.Page; import org.springframework.data.domain.Pageable; import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.data.jpa.repository.Query; import org.springframework.data.repository.query.Param; import java.util.List; public interface QuestionRepository extends JpaRepository { Question findBysubject(String subject); Question findBySubjectAndContent(String subject, String content); List findBySubjectLike(String subject); Page findAll(Pageable pageable); @Query("select " + "distinct q " + "from Question q " + "left outer join SiteUser u1 on q.author=u1 " + "left outer join Answer a on a.question=q " + "left outer join SiteUser u2 on a.author=u2 " + "where " + " q.subject like %:kw% " + " or q.content like %:kw% " + " or u1.username like %:kw% " + " or a.content like %:kw% " + " or u2.username like %:kw% ") Page findAllByKeyword(@Param("kw") String kw, Pageable pageable); } ``` ㅤ #### ? QuestionService.java - Service ```java package com.ll.SBB0524.question; import com.ll.SBB0524.DataNotFoundException; import com.ll.SBB0524.answer.Answer; import com.ll.SBB0524.user.SiteUser; import lombok.RequiredArgsConstructor; import org.springframework.data.domain.Page; import org.springframework.data.domain.PageRequest; import org.springframework.data.domain.Pageable; import org.springframework.data.domain.Sort; import org.springframework.data.jpa.domain.Specification; import org.springframework.stereotype.Service; import jakarta.persistence.criteria.CriteriaBuilder; import jakarta.persistence.criteria.CriteriaQuery; import jakarta.persistence.criteria.Join; import jakarta.persistence.criteria.JoinType; import jakarta.persistence.criteria.Predicate; import jakarta.persistence.criteria.Root; import java.time.LocalDateTime; import java.util.ArrayList; import java.util.List; import java.util.Optional; @RequiredArgsConstructor @Service public class QuestionService { private final QuestionRepository questionRepository; private Specification search(String kw) { return new Specification<>() { private static final long serialVersionUID = 1L; @Override public Predicate toPredicate(Root q, CriteriaQuery query, CriteriaBuilder cb) { query.distinct(true); // 중복을 제거 Join u1 = q.join("author", JoinType.LEFT); Join a = q.join("answerList", JoinType.LEFT); Join u2 = a.join("author", JoinType.LEFT); return cb.or(cb.like(q.get("subject"), "%" + kw + "%"), // 제목 cb.like(q.get("content"), "%" + kw + "%"), // 내용 cb.like(u1.get("username"), "%" + kw + "%"), // 질문 작성자 cb.like(a.get("content"), "%" + kw + "%"), // 답변 내용 cb.like(u2.get("username"), "%" + kw + "%")); // 답변 작성자 } }; } public ListgetList() { return this.questionRepository.findAll(); } public Question getQuestion(Integer id) { Optional question = this.questionRepository.findById(id); if (question.isPresent()) { return question.get(); } else { throw new DataNotFoundException("question not found"); } } public void create(String subject, String content, SiteUser user) { Question q = new Question(); q.setSubject(subject); q.setContent(content); q.setCreateDate(LocalDateTime.now()); q.setAuthor(user); this.questionRepository.save(q); } public Page getList(int page, String kw) { List sorts = new ArrayList<>(); sorts.add(Sort.Order.desc("createDate")); Pageable pageable = PageRequest.of(page, 10, Sort.by(sorts)); Specification spec = search(kw); return this.questionRepository.findAllByKeyword(kw, pageable); } public void modify(Question question, String subject, String content) { question.setSubject(subject); question.setContent(content); question.setModifyDate(LocalDateTime.now()); this.questionRepository.save(question); } public void delete(Question question) { this.questionRepository.delete(question); } public void vote(Question question, SiteUser siteUser) { question.getVoter().add(siteUser); this.questionRepository.save(question); } } ``` ㅤ #### ? QuestionController.java - Controller - 목록 조회/ 상세조회 / 생성 / 수정 / 삭제 / 추천 메소드 ```java package com.ll.SBB0524.question; import com.ll.SBB0524.answer.AnswerForm; import com.ll.SBB0524.user.SiteUser; import com.ll.SBB0524.user.UserService; import jakarta.validation.Valid; import org.springframework.data.domain.Page; import org.springframework.http.HttpStatus; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.validation.BindingResult; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestParam; import lombok.RequiredArgsConstructor; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.server.ResponseStatusException; import org.springframework.security.access.prepost.PreAuthorize; import java.security.Principal; @RequestMapping("/question") @RequiredArgsConstructor @Controller public class QuestionController { private final QuestionService questionService; private final UserService userService; @GetMapping("/list") public String list(Model model, @RequestParam(value="page", defaultValue="0") int page, @RequestParam(value = "kw", defaultValue = "") String kw) { Page paging = this.questionService.getList(page, kw); model.addAttribute("paging", paging); model.addAttribute("kw", kw); return "question_list"; } @GetMapping(value = "/detail/{id}") public String detail(Model model, @PathVariable("id") Integer id, AnswerForm answerForm) { Question question = this.questionService.getQuestion(id); model.addAttribute("question", question); return "question_detail"; } @PreAuthorize("isAuthenticated()") @GetMapping("/create") public String questionCreate(QuestionForm questionForm) { return "question_form"; } @PreAuthorize("isAuthenticated()") @PostMapping("/create") public String questionCreate(@Valid QuestionForm questionForm, BindingResult bindingResult, Principal principal) { if (bindingResult.hasErrors()) { return "question_form"; } SiteUser siteUser = this.userService.getUser(principal.getName()); this.questionService.create(questionForm.getSubject(), questionForm.getContent(), siteUser); return "redirect:/question/list"; // 질문 저장후 질문목록으로 이동 } @PreAuthorize("isAuthenticated()") @GetMapping("/modify/{id}") public String questionModify(QuestionForm questionForm, @PathVariable("id") Integer id, Principal principal) { Question question = this.questionService.getQuestion(id); if(!question.getAuthor().getUsername().equals(principal.getName())) { throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "수정권한이 없습니다."); } questionForm.setSubject(question.getSubject()); questionForm.setContent(question.getContent()); return "question_form"; } @PreAuthorize("isAuthenticated()") @PostMapping("/modify/{id}") public String questionModify(@Valid QuestionForm questionForm, BindingResult bindingResult, Principal principal, @PathVariable("id") Integer id) { if (bindingResult.hasErrors()) { return "question_form"; } Question question = this.questionService.getQuestion(id); if (!question.getAuthor().getUsername().equals(principal.getName())) { throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "수정권한이 없습니다."); } this.questionService.modify(question, questionForm.getSubject(), questionForm.getContent()); return String.format("redirect:/question/detail/%s", id); } @PreAuthorize("isAuthenticated()") @GetMapping("/delete/{id}") public String questionDelete(Principal principal, @PathVariable("id") Integer id) { Question question = this.questionService.getQuestion(id); if (!question.getAuthor().getUsername().equals(principal.getName())) { throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "삭제권한이 없습니다."); } this.questionService.delete(question); return "redirect:/"; } @PreAuthorize("isAuthenticated()") @GetMapping("/vote/{id}") public String questionVote(Principal principal, @PathVariable("id") Integer id) { Question question = this.questionService.getQuestion(id); SiteUser siteUser = this.userService.getUser(principal.getName()); this.questionService.vote(question, siteUser); return String.format("redirect:/question/detail/%s", id); } } ``` ㅤ #### ? QuestionForm.java - Form - 입력란 조건 생성 ```java package com.ll.SBB0524.question; import jakarta.validation.constraints.NotEmpty; import jakarta.validation.constraints.Size; import lombok.Getter; import lombok.Setter; @Getter @Setter public class QuestionForm { @NotEmpty(message = "제목은 필수항목입니다.") @Size(max=200) private String subject; @NotEmpty(message = "내용은 필수항목입니다.") private String content; } ``` ㅤ ### ⭐ 질문 목록 ---- ![질문목록](https://i.imgur.com/Othhcc7.png) ![질문목록2](https://i.imgur.com/znQA24D.png) #### ? question_list.html ```html

질문 등록하기

번호	제목	글쓴이	작성일시

``` ㅤ ### ⭐ 질문 상세 ---- ![질문상세](https://i.imgur.com/kJ0qOmO.png) #### ? question_detail.html ```html

modified at

``` ㅤ ### ⭐ 질문 등록 + 수정 ---- ![질문등록](https://i.imgur.com/zqZOWgJ.png) ![질문수정](https://i.imgur.com/7zywaRl.png) #### ? question_form.html ```html

질문등록

``` ㅤ ### ⭐ 답변 ---- #### ? Answer.java - Entity ```java package com.ll.SBB0524.answer; import com.ll.SBB0524.question.Question; import com.ll.SBB0524.user.SiteUser; import jakarta.persistence.*; import lombok.Getter; import lombok.Setter; import java.time.LocalDateTime; import java.util.Set; @Getter @Setter @Entity public class Answer { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Integer id; @Column(columnDefinition = "TEXT") private String content; private LocalDateTime createDate; @ManyToOne private Question question; @ManyToOne private SiteUser author; private LocalDateTime modifyDate; @ManyToMany(fetch = FetchType.EAGER) Set voter; } ``` ㅤ #### ? AnswerRepository.java - Repository ```java package com.ll.SBB0524.answer; import org.springframework.data.jpa.repository.JpaRepository; public interface AnswerRepository extends JpaRepository { } ``` ㅤ #### ? AnswerService.java - Service ```java package com.ll.SBB0524.answer; import com.ll.SBB0524.DataNotFoundException; import com.ll.SBB0524.question.Question; import com.ll.SBB0524.user.SiteUser; import lombok.RequiredArgsConstructor; import org.springframework.stereotype.Service; import java.time.LocalDateTime; import java.util.Optional; @RequiredArgsConstructor @Service public class AnswerService { private final AnswerRepository answerRepository; public Answer create(Question question, String content, SiteUser author) { Answer answer = new Answer(); answer.setContent(content); answer.setCreateDate(LocalDateTime.now()); answer.setQuestion(question); answer.setAuthor(author); this.answerRepository.save(answer); return answer; } public Answer getAnswer(Integer id) { Optional answer = this.answerRepository.findById(id); if (answer.isPresent()) { return answer.get(); } else { throw new DataNotFoundException("answer not found"); } } public void modify(Answer answer, String content) { answer.setContent(content); answer.setModifyDate(LocalDateTime.now()); this.answerRepository.save(answer); } public void delete(Answer answer) { this.answerRepository.delete(answer); } public void vote(Answer answer, SiteUser siteUser) { answer.getVoter().add(siteUser); this.answerRepository.save(answer); } } ``` ㅤ #### ? AnswerController.java - Controller - 답변 작성 / 수정 / 삭제 / 추천 메소드 ```java package com.ll.SBB0524.answer; import com.ll.SBB0524.question.Question; import com.ll.SBB0524.question.QuestionService; import com.ll.SBB0524.user.SiteUser; import com.ll.SBB0524.user.UserService; import lombok.RequiredArgsConstructor; import org.springframework.http.HttpStatus; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestMapping; import jakarta.validation.Valid; import org.springframework.validation.BindingResult; import org.springframework.web.server.ResponseStatusException; import java.security.Principal; @RequestMapping("/answer") @RequiredArgsConstructor @Controller public class AnswerController { private final QuestionService questionService; private final AnswerService answerService; private final UserService userService; @PreAuthorize("isAuthenticated()") @PostMapping("/create/{id}") public String createAnswer(Model model, @PathVariable("id") Integer id, @Valid AnswerForm answerForm, BindingResult bindingResult, Principal principal) { Question question = this.questionService.getQuestion(id); SiteUser siteUser = this.userService.getUser(principal.getName()); if (bindingResult.hasErrors()) { model.addAttribute("question", question); return "question_detail"; } Answer answer = this.answerService.create(question, answerForm.getContent(), siteUser); return String.format("redirect:/question/detail/%s#answer_%s", answer.getQuestion().getId(), answer.getId()); } @PreAuthorize("isAuthenticated()") @GetMapping("/modify/{id}") public String answerModify(AnswerForm answerForm, @PathVariable("id") Integer id, Principal principal) { Answer answer = this.answerService.getAnswer(id); if (!answer.getAuthor().getUsername().equals(principal.getName())) { throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "수정권한이 없습니다."); } answerForm.setContent(answer.getContent()); return "answer_form"; } @PreAuthorize("isAuthenticated()") @PostMapping("/modify/{id}") public String answerModify(@Valid AnswerForm answerForm, BindingResult bindingResult, @PathVariable("id") Integer id, Principal principal) { if (bindingResult.hasErrors()) { return "answer_form"; } Answer answer = this.answerService.getAnswer(id); if (!answer.getAuthor().getUsername().equals(principal.getName())) { throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "수정권한이 없습니다."); } this.answerService.modify(answer, answerForm.getContent()); return String.format("redirect:/question/detail/%s", answer.getQuestion().getId()); } @PreAuthorize("isAuthenticated()") @GetMapping("/delete/{id}") public String answerDelete(Principal principal, @PathVariable("id") Integer id) { Answer answer = this.answerService.getAnswer(id); if (!answer.getAuthor().getUsername().equals(principal.getName())) { throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "삭제권한이 없습니다."); } this.answerService.delete(answer); return String.format("redirect:/question/detail/%s", answer.getQuestion().getId()); } @PreAuthorize("isAuthenticated()") @GetMapping("/vote/{id}") public String answerVote(Principal principal, @PathVariable("id") Integer id) { Answer answer = this.answerService.getAnswer(id); SiteUser siteUser = this.userService.getUser(principal.getName()); this.answerService.vote(answer, siteUser); return String.format("redirect:/question/detail/%s#answer_%s", answer.getQuestion().getId(), answer.getId()); } } ``` ㅤ #### ? AnswerForm.java - Form - 답변 내용 작성 조건 생성 ```java package com.ll.SBB0524.answer; import jakarta.validation.constraints.NotEmpty; import lombok.Getter; import lombok.Setter; @Getter @Setter public class AnswerForm { @NotEmpty(message = "내용은 필수항목입니다.") private String content; } ``` ㅤ ### ⭐ 답변 목록 + 등록 ---- ![답변](https://i.imgur.com/atfIbFv.png) #### ? question_detail.html ```html

modified at

``` ㅤ ### ⭐ 답변 수정 ---- ![답변 수정](https://i.imgur.com/vOm9uA4.png) #### ? answer_form.html ```html

답변 수정

``` ㅤ ### ⭐ 알림 ---- ![삭제](https://i.imgur.com/i5zzAQX.png) ![추천](https://i.imgur.com/kEea4FT.png) ㅤ #### ? question_detail.html ```js ``` ㅤ ### ⭐ 마크다운 ---- #### ? CommonUtil.java ```java package com.ll.SBB0524; import org.commonmark.node.Node; import org.commonmark.parser.Parser; import org.commonmark.renderer.html.HtmlRenderer; import org.springframework.stereotype.Component; @Component public class CommonUtil { public String markdown(String markdown) { Parser parser = Parser.builder().build(); Node document = parser.parse(markdown); HtmlRenderer renderer = HtmlRenderer.builder().build(); return renderer.render(document); } } ``` ㅤ ### ⭐ 설정 ---- #### ? SecurityConfig.java - 로그인 / 로그아웃 설정 - 비밀번호 암호화 설정 - 권한 부여 설정 ```java package com.ll.SBB0524; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder; import org.springframework.security.crypto.password.PasswordEncoder; import org.springframework.security.web.SecurityFilterChain; import org.springframework.security.web.header.writers.frameoptions.XFrameOptionsHeaderWriter; import org.springframework.security.web.util.matcher.AntPathRequestMatcher; import org.springframework.security.authentication.AuthenticationManager; import org.springframework.security.config.annotation.authentication.configuration.AuthenticationConfiguration; import org.springframework.security.config.annotation.method.configuration.EnableMethodSecurity; @Configuration @EnableWebSecurity @EnableMethodSecurity(prePostEnabled = true) public class SecurityConfig { @Bean SecurityFilterChain filterChain(HttpSecurity http) throws Exception { http .authorizeHttpRequests((authorizeHttpRequests) -> authorizeHttpRequests .requestMatchers(new AntPathRequestMatcher("/**")).permitAll()) .formLogin((formLogin) -> formLogin .loginPage("/user/login") .defaultSuccessUrl("/")) .logout((logout) -> logout .logoutRequestMatcher(new AntPathRequestMatcher("/user/logout")) .logoutSuccessUrl("/") .invalidateHttpSession(true)) ; return http.build(); } @Bean PasswordEncoder passwordEncoder() { return new BCryptPasswordEncoder(); } @Bean AuthenticationManager authenticationManager(AuthenticationConfiguration authenticationConfiguration) throws Exception { return authenticationConfiguration.getAuthenticationManager(); } } ``` ㅤ ### ⭐ 에러 ---- #### ? form_error.html ```html

``` ㅤ ## ✔️ 기술 테스트 ㅤ | 기술테스트 | | | | | | | | --- | --- | --- | --- | --- | --- | | 회원가입 | ✅2022-05-17 | ✅2022-08-04 | | | | 로그인 | ✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 로그아웃 | ✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 질문 목록 조회 | ✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 질문 상세 조회 | ✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 질문 등록 | ✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 질문 수정 |✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 질문 삭제 |✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 질문 검색 | ✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 질문 추천 |✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 답변 개수 조회 |✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 답변 조회 |✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 답변 작성 |✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 답변 수정 |✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 답변 삭제 |✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 답변 추천 |✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 입력 오류 팝업 출력 |✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 알림 팝업 출력 |✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 답변 작성 |✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 페이지네이션 작동 |✅2022-05-17 | ✅2022-08-04 | | | | | | | | | 마크다운 작동 |✅2022-05-17 | ✅2022-08-04 | | | | | | | | ㅤ ㅤ ?감사합니다?