$$config title: ⚽️자유 게시판 서비스 기술서 keywords: - 풀스택 - 자유로운 게시글 - 여러 사람들간의 소통 $$ # ?개요 ## 가. 소개 - **사이트 명 : 자유게시판 - 스프링부트를 이용한 자유 게시판 사이트 제작 - 다양한 사람들이 모여 어떠한 주제로 게시글, 질문, 답글 등을 달아 소통 - 각 게시글에 답글 추천 기능 ## 나. 사이트 주소 - [자유게시판](http://118.67.135.62/question/list) --- # ?환경 ## 가. 형상관리 - [깃허브 형상관리 : 깃허브 바로가기](https://github.com/kimdaeun12/newSBB.git) ## 나. 기술스택 ``` - Java - HTML/CSS/JS - Thymeleaf - CentOS - jQuery - MariaDB - Bootstrap - Github action ``` ## 다. 개발환경 ``` - Mysql - Intellij - Mac.os ``` # ?요구사항과 기능구현 여부 |목록|요구사항|이용대상|기능종류|구현여부|비고 | --- | --- | --- | --- |---|---| |RQ-001|게시글 제목으로 검색이 가능하다 | 모든 유저|검색|✅| |RQ-002|게시글 내용으로 검색이 가능하다|모든 유저|검색|✅| |RQ-003|게시글 답변 내용으로 검색이 가능하다|회원|검색|✅| |RQ-004|게시글 등록이 가능하다|회원|등록|✅| |RQ-005|각 게시글에 댓글 등록이 가능하다|회원|등록|✅| |RQ-006|게시글을 추천 할 수있다.|회원|등록|✅| |RQ-007|게시글의 댓글을 추천 할 수있다.|회원|등록|✅| |RQ-008|게시글을 최신순으로 정렬 되어있다.|모든 유저|정렬|✅| |RQ-009|게시글 목록은 한페이지에 10개씩 보여진다.|모든 유저|정렬|✅| |RQ-010|회원가입 페이지에서 사용자의 각종 정보를 입력후 회원가입을 할 수 있다.|모든 유저|회원가입|✅| |RQ-011|사용자가 회원가입을 했을때 입력하였던 아이디와 비밀번호로 로그인이 가능하고 로그아웃이 가능하다|모든유저|로그인|✅| |RQ-012|게시글 목록에서 게시글 옆에 댓글의 개수가 표시된다|모든 유저|출력|✅| |RQ-013|게시글 목록에서 게시글 옆에 작성자의 아이디가 출력된다|모든 유저|출력|✅| |RQ-014|게시글을 작성한 작성자가 본인이 작성한 게시글을 수정할 수 있다.|회원|수정|✅| |RQ-015|게시글을 작성한 작성자가 본인이 작성한 게시글을 삭제할 수 있다.|회원|삭제|✅| --- # ?모델 구성과 주요 동작 알고리즘 ## ?Entity Relationship Diagram

--- # ?기능 ## 동작 화면과 소스코드 ### 공통사용

--- #### ?주요 소스코드 - ?base > static 폴더 내부 정적파일 가져오기 ```html ``` --- - ?공통 사용된 layout ```html ``` --- - ?내비게이션 바 메뉴 (layout에 내포된 내비게이션) ```html 로그인 로그아웃 회원가입 ``` --- ### 로그인 --- #### ?‍동작화면

--- ### ?주요 소스코드 - ? SecurityConfig ```java @Configuration @EnableWebSecurity @EnableMethodSecurity(prePostEnabled = true) public class SecurityConfig { @Bean SecurityFilterChain filterChain(HttpSecurity http) throws Exception { http.authorizeHttpRequests().requestMatchers( new AntPathRequestMatcher("/**")).permitAll() .and() .csrf().ignoringRequestMatchers( new AntPathRequestMatcher("/h2-console/**")) .and() .headers() .addHeaderWriter(new XFrameOptionsHeaderWriter( XFrameOptionsHeaderWriter.XFrameOptionsMode.SAMEORIGIN)) .and() .formLogin() .loginPage("/user/login") .defaultSuccessUrl("/") .and() .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(); } } ``` --- - ? SiteUser(유저 Entity) ```java 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; } ``` --- - ? UserController ```java @RequiredArgsConstructor @Controller @RequestMapping("/user") public class UserController { private final UserService userService; @GetMapping("/login") public String login() { return "login_form"; } } ``` --- - ? UserService ```java @RequiredArgsConstructor @Service public class UserService { private final UserRepository userRepository; private final PasswordEncoder passwordEncoder; public SiteUser getUser(String username) { Optional siteUser = this.userRepository.findByusername(username); if (siteUser.isPresent()) { return siteUser.get(); } else { throw new DataNotFoundException("siteuser not found"); } } } ``` --- - ? UserRole(권한 부여) ```java @Getter public enum UserRole { ADMIN("ROLE_ADMIN"), USER("ROLE_USER"); UserRole(String value) { this.value = value; } private String value; } ``` --- - ? UserSecurityService ```java @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); } } ``` --- - ? login_form ```html

``` --- ### 회원가입 --- #### ?‍동작화면 - ? 회원 가입

--- #### ?주요 소스코드 - ? UserCreateForm ```java @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; } ``` --- - ? UserService ```java @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; } } ``` --- - ? UserController ```java @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:/"; } } ``` --- - ? signup_form ```html

회원가입

``` ###게시글 목록 --- #### ?‍동작화면 - ?메인 페이지

--- - ?게시글 등록

--- - ? QuestionController ```java @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"; } @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"; } ``` --- - ? QuestionService ```java 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.findAll(spec, pageable); } 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); } 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 + "%")); // 답변 작성자 } }; } ``` --- - ? Question(Entity) ```java @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) private List answerList; @ManyToOne private SiteUser author; private LocalDateTime modifyDate; @ManyToMany Set voter; } ``` --- - ? QuestionForm ```java @Getter @Setter public class QuestionForm { @NotEmpty(message="제목은 필수항목입니다.") @Size(max=200) private String subject; @NotEmpty(message="내용은 필수항목입니다.") private String content; } ``` --- - ? QuestionRepository ```java Page findAll(Pageable pageable); Page findAll(Specification spec, 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); ``` --- - ?quesiton_list (게시글 목록) ```html

질문 등록하기

번호	제목	글쓴이	작성일시

``` --- - ?quesiton_list (게시글 검색) ```html ``` --- - ? question_form (게시글 등록) ```html

질문등록

``` ### 게시글 상세페이지 --- #### ?‍동작화면 - ?게시글 제목과 내용 글쓴이 작성일 표출

--- - ? 게시글 수정과 삭제

--- - ? 댓글 등록

--- - ? 댓글 수정과 삭제

--- - ?게시글 추천과 댓글 추천

--- #### ?주요 소스코드 --- - ? QuestionController ```java @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("/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("/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); } ``` --- - ?QuestionService ```java 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 vote(Question question, SiteUser siteUser) { question.getVoter().add(siteUser); this.questionRepository.save(question); } ``` --- - ?UserService ```java public SiteUser getUser(String username) { Optional siteUser = this.userRepository.findByusername(username); if (siteUser.isPresent()) { return siteUser.get(); } else { throw new DataNotFoundException("siteuser not found"); } } ``` --- - ?AnswerController ```java @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_%s", answer.getQuestion().getId(), answer.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()); } } ``` --- - ?AnswerService ```java 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); } ``` --- # ?테스트 내용 |순번|테스트|결과|비고| |---|---|---|---| 1|게시글 리스트 출력|✅ 2|게시글 리스트에서 게시글 제목 및 작성자로 검색 |✅ 3|회원가입|✅ 4|로그인|✅ 5|로그아웃|✅ 6|게시글 상세페이지 제목 내용 출력|✅ 7|게시글 추천 가능|✅ 8|댓글 작성 가능|✅ 9|댓글 추천 가능|✅ 10|게시글 및 댓글 수정,삭제 가능|✅ # ? 배포 - 가. ? 가비아 - 구매, 결제, 연장 진행 - 나. ?dnszi - 도메인관리 - 관리소유권 받아오기 - 다. ?네이버클라우드플랫폼 - CentOS로 진행 - 포트포워딩 진행 - 라. ?Nginx 프록시 서버 - 프록시 호스트 추가

- 프록시 호스트 추가시 SSL security 적용 (https://)

- 마. ?배포 진행 - 도커를 통한 자바 설치✅ - github Action 설치 및 실행 - Maria DB 설치 - nginx 설치

- 바. ?‍?Github Action 내용 작성 - 배포 성공 ✅

- 배포 실패