Skip to content

ventulus95/Bomnae-exhibition-jwt

Repository files navigation

📷 봄내 사진예술연구회 온라인 사진전 Backend-Server 🎟

사진동아리 온라인 사진전을 위한 서버

 

목차

  

프로젝트에 대하여

왜 이 프로젝트를 기획했었는가?

최근 코로나19 때문에 많은 대학교 동아리들이 정상적인 동아리 활동을 진행할 수 없었습니다. 제가 다니고 있었던 사진동아리도 역시 똑같이 정상적인 동아리 활동을 할 수 없었습니다. 저희 사진동아리는 주기적으로 매년마다 학교 전시장을 빌려 전시회를 진행했으나, 이런 전시장도 물론이거니와 비대면으로 변화해버린 학교 상황에 정상적인 전시활동을 하기에는 부적합했습니다.
그래서 코로나라는 이 상황과 학교 내부에서 전시를 할 수 없는 상황에서 가장 최선책인 프로젝트인 온라인 전시회를 기획하였고, 저는 그 온라인 전시회에서 서버를 담당하게 되었습니다.

 

기술 스택

  • Java 8
  • Spring Boot 2.3.3.RELEASE
  • Spring Security
  • Spring JPA
  • Maria DB (RDS)
  • AWS EC2
  • AWS S3, CloudFront
  • Gradle
  • JWT
  • NGINX

 

Getting Started

 

Details

Dependencies

plugins {
	id 'org.springframework.boot' version '2.3.3.RELEASE'
	id 'io.spring.dependency-management' version '1.0.10.RELEASE'
	id 'java'
}

group = 'com.ventulus95'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

configurations {
	compileOnly {
		extendsFrom annotationProcessor
	}
}

repositories {
	mavenCentral()
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
	implementation 'org.springframework.boot:spring-boot-starter-security'
	implementation 'org.springframework.boot:spring-boot-starter-web'
	compileOnly 'org.projectlombok:lombok'
	developmentOnly 'org.springframework.boot:spring-boot-devtools'
	runtimeOnly 'com.h2database:h2'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation('org.springframework.boot:spring-boot-starter-test') {
		exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
	}
	testImplementation 'org.springframework.security:spring-security-test'
	compile group: 'org.springframework.boot', name: 'spring-boot-starter-oauth2-client', version: '2.2.5.RELEASE'
	compile group: 'io.jsonwebtoken', name: 'jjwt', version: '0.9.1'
	compile 'org.springframework.boot:spring-boot-starter-validation'
	implementation group: 'org.springframework.cloud', name: 'spring-cloud-starter-aws', version: '2.2.1.RELEASE'
	compile("org.mariadb.jdbc:mariadb-java-client")
	compile group: 'com.drewnoakes', name: 'metadata-extractor', version: '2.11.0'
}

test {
	useJUnitPlatform()
}

 

Profile

application.yml은 이렇게 설정되어있습니다. spring.profile.active을 설정하면 옵션없이 실행시키면 그 기본 Profile로 실행됩니다. 저의 경우 github-action을 통한 build 작업을 하기때문에 기본을 action으로 설정했습니다.

spring:
  devtools:
    livereload:
      enabled: true
  profiles:
    active: action
  jackson:
    serialization:
        fail-on-empty-beans: false
  servlet:
    multipart:
      max-file-size: 500MB

profile을 적용하기위해서는 다음과 같은 양식을 사용합니다. application-profile이름.yml ex) application-dev.yml 이런식으로 구성하면 됩니다. 아래는 개발자 설정을 가져왔습니다. 실제 프로덕션에서 사용하는 중요한 정보들을 가지고 있는 Profile 입니다.

spring:
  profiles: dev -> 다음과 같이 DEV를 이용해서 Profiles의 이름을 지정합니다. 
  jackson:
    serialization:
      fail-on-empty-beans: false
  h2:
    console:
      enabled: false
  jpa:
    show-sql: true
    hibernate:
      ddl-auto: none
  datasource:
      url: DB주소
      username: DB 유저 이름
      password: DB 유저 비밀번호
      driver-class-name: org.mariadb.jdbc.Driver
  security:
    oauth2:
      client:
        registration:
          google:
            client-id: 구글 client-id
            client-secret: 구글 client-secret키
            scope: email, profile
          kakao:
            client-id: 카카오 client-id
            client-secret: 카카오 client-secret키
            redirectUri: '{baseUrl}/login/oauth2/code/{registrationId}'
            authorization-grant-type: authorization_code
            scope: profile,account_email
            client-name: kakao
            clientAuthenticationMethod: post
        provider:
          kakao:
            authorization-uri: https://kauth.kakao.com/oauth/authorize
            token-uri: https://kauth.kakao.com/oauth/token
            user-info-uri: https://kapi.kakao.com/v2/user/me
            user-name-attribute: id
app:
  auth:
    tokenSecret: 토큰시크릿키
    tokenExpirationMsec: 토큰만료시간
  oauth2:
    authorizedRedirectUris: http://localhost:3000/oauth2/redirect

cloud:
  aws:
    credentials:
      access-key: AWS 키
      secret-key: AWS 시크릿 키
    s3:
      bucket: S3 버켓이름
    region:
      static: ap-northeast-2
    stack:
      auto: false

application-action을 통해서 CI를 설정할 수 있습니다. github repository의 설정에서 secret키를 통해 중요정보를 숨길 수 있습니다.

spring:
  profiles: action
  jackson:
    serialization:
      fail-on-empty-beans: false
  h2:
    console:
      enabled: false
  jpa:
    show-sql: true
    hibernate:
      ddl-auto: none

cloud:
  aws:
    credentials:
      access-key: ${accesskey}
      secret-key: ${secretkey}
    s3:
      bucket: S3 버킷 이름
    region:
      static: ap-northeast-2
    stack:
      auto: false

실행시 권고사항

-DSpring.profiles.active=dev를 통해 profile을 java 실행시 변경할 수도 있습니다.

Description & Architecture

봄내사진예술연구회온라인전시회

Spring Boot가 백엔드 API서버를 담당하고 있습니다. React를 통해 프론트엔드를 담당하고 있습니다. 이 둘간의 서버 교환을 통해서 전시회 서버가 운용되고 있습니다.

내부적으로 두개의 관점으로 서버가 운용가능한데, 1. 관리자 입장과, 2. 유저입장에서 접근이 가능합니다. 1. 관리자 입장에서는 내부 전시용 사진들을 올립니다. 사진 파일들을 사이즈가 크고 EC2 내부 Stroage에 직접 저장하는 것보다 AWS S3를 활용하여, S3에 정적 이미지 파일들을 올리고 이 이미지 파일들을 AWS CloudFront에 Caching하여 실제 처음 접속하는 경우를 제외한 속도를 높이기 위해 Cache 서버를 적용하였습니다.

2, 외부유저들은 대부분 핸드폰으로 접속할 가능성이 크고, Frontend를 React를 통해서 접속하기 때문에 로그인을 JWT를 통한 Token 방식의 로그인 방식을 채용했습니다. Spring Security와 JWT을 활용한 서버 인증과 Oauth2.0을 통한 내부 로그인시 Google과 카카오톡을 활용한 소셜로그인 체계를 구축하였습니다. Spring Security 활용한 JWT를 기반으로 하는 Oauth2.0 로그인은 다음 사이트를 참고하여 개발하였습니다.

https://www.callicoder.com/spring-boot-security-oauth2-social-login-part-1/

외부유저들은 방명록, 사진관람과 같은 활동을 할 수 있습니다.

제가 직접 프론트엔드의 배포작업도 진행하였고, 직접 CI툴을 활용한 React 빌드 과정을 간소화했습니다. EC2 프리티어를 활용한 React build과정은 시간이 너무 오래 걸리는 작업이기때문에, Github Actions 을 활용해서 git commit후 build 작업을 처리후 AWS S3에 그 Build 파일을 올라가게 됩니다. EC2에 직접 AWS CLI를 통해 S3 와 Sync 작업을 통해 Build파일을 일치화합니다. 그 이후에 NGINX를 통해 배포합니다.

 

Demo

  1. 사진 전시 기능. 사진 전시와 사진에 대한 여러가지 정보들을 같이 노출합니다. 사진의 제목, 작가명, 사진 설명, 사진 메타데이터들을 자동으로 노출시켜줍니다.

  1. 방명록 기능 소셜로그인을 통해서 로그인한 유저이름과 소셜로그인 사진으로 방명록 작성을 할 수 있습니다.

  1. 소셜로그인 기능: 구글과 카카오를 통한 소셜로그인 기능이 있습니다.

더 자세한 시연영상은 아래 링크를 참조 해주세요.

유튜브 링크

결과

온라인 사진전을 개최하며 겪었던 후일담 -1편
온라인 사진전을 개최하며 겪었던 후일담 -2편

Contributers

문의

  • 코로나 때문에 전시회를 열지 못하는 사진 전시회가 필요한 대학 사진 동아리 혹은 소규모 사진 동호회분들은 연락주시면 친절하게 답변 드리겠습니다.
  • 문의 이메일: ventulus95@gmail.com

About

봄내 사진예술연구회 온라인 사진전 Backend-Server (Back-Admin, Hosting)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages