표준프레임워크 심플홈페이지 BackEnd

※ 본 프로젝트는 기존 JSP 뷰 방식에서 벗어나 BackEnd와 FrontEnd를 분리한 아키텍처를 제공하는 예시 프로젝트입니다. 실제 구현 시 참고용으로 활용하시기 바랍니다.

환경 설정

프로젝트에서 사용된 환경 프로그램 정보는 다음과 같습니다.

프로그램 명	버전 명
java	1.8 이상
maven	3.8.4

BackEnd 구동

CLI 구동 방법

mvn spring-boot:run

IDE에서 BackEnd 구동 방법

개발환경에서 프로젝트 우클릭 > Run As > Spring Boot App을 선택하여 애플리케이션을 구동합니다.

BackEnd 구동 후 확인

구동 후, 브라우저에서 http://localhost:포트번호/로 접속하여 서비스를 확인할 수 있습니다.
초기 포트번호는 8080이며, /src/main/resources/application.properties 파일의 server.port 항목에서 변경할 수 있습니다.

Swagger API 문서 확인 및 테스트 방법

• Swagger 3.x: http://localhost:포트번호/swagger-ui/index.html에서 API 엔드포인트를 확인할 수 있습니다.
• Swagger 2.x(참고): http://localhost:포트번호/swagger-ui.html에서 API 엔드포인트를 확인할 수 있었습니다.
• API 인증 정보:
  • GET 요청은 JWT 토큰 인증 없이 사용 가능합니다.
  • POST, PUT, DELETE 요청은 JWT 토큰을 통한 인증이 필요합니다.
  • 인증되지 않은 요청은 401(403) "인가된 사용자가 아닙니다."와 같은 오류 메시지가 표시됩니다.

JWT 토큰 인증 방법

1. Swagger에서 /auth/login-jwt 엔드포인트의 [Try it out] 기능을 사용합니다.
2. 아이디/암호(admin/1)를 입력하고 [Execute]를 클릭합니다.
3. [Response body]에서 "jToken": "토큰 값"의 토큰 값을 복사합니다.
4. Swagger 상단의 [Authorize] 버튼을 클릭하고, 복사한 토큰을 Value 필드에 입력한 후 [Authorize]를 클릭합니다.
5. 인증이 완료되면 보안이 필요한 모든 엔드포인트를 사용할 수 있습니다.

FrontEnd 구동 (React)

현재 FrontEnd는 React 기반으로 구성되어 있습니다. 심플홈페이지FrontEnd 저장소에서 소스를 받아 구동하시기 바랍니다.

변경 사항

1. Java Config 변환

1) Web.xml을 WebApplicationInitializer 구현체로 변환

2) context-*.xml 파일을 @Configuration 클래스로 변환

3) properties 파일 변환 (Spring Boot 지원 예정)

2. API 변환

기존 직접 View와 연결하던 방식에서 API 형식으로 변환하여 다양한 프론트엔드 프레임워크에서 활용할 수 있도록 예제를 제공합니다.

※ API 컨트롤러는 파일명이 ~ApiController.java 형식으로 되어 있어 쉽게 식별할 수 있습니다.

Jar 파일 실행 방법

java -jar <jar파일명> --spring.profiles.active=<profile명>

위 명령어를 사용하여 특정 프로필로 애플리케이션을 실행할 수 있습니다.