Trecord backend

Intro

• Gradle mono module project
• Monolithic Structure
• 3-layer(presentation,logic,data) Structure

Tech

• Backend
  • Java 17, SpringBoot 3.1.3, Gradle 8.2.1
  • JPA with QueryDSL, Spring Security
  • JUnit5, Mockito
• Data
  • MariaDB, Redis
• Infra
  • Docker, Github actions, AWS EC2 with DB (Use EC2 with EB instead of ECS for cost and management issues)

Modules

dependencies {

    //springboot
    implementation 'org.springframework.boot:spring-boot-starter-validation'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.springframework.boot:spring-boot-starter-security'
    annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'

    //spring-cloud
    implementation 'org.springframework.cloud:spring-cloud-starter-openfeign' // For @FeignClient

    //jwt
    implementation 'io.jsonwebtoken:jjwt-api:0.11.5'
    implementation 'io.jsonwebtoken:jjwt-impl:0.11.5'
    implementation 'io.jsonwebtoken:jjwt-jackson:0.11.5'

    //data
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-data-redis'
    implementation 'io.hypersistence:hypersistence-utils-hibernate-62:3.5.1' // For @Type(JsonType.class)
    runtimeOnly 'org.mariadb.jdbc:mariadb-java-client'

    //querydsl
    implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
    annotationProcessor "com.querydsl:querydsl-apt:${dependencyManagement.importedProperties['querydsl.version']}:jakarta"
    annotationProcessor "jakarta.annotation:jakarta.annotation-api"
    annotationProcessor "jakarta.persistence:jakarta.persistence-api"

    //lombok
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'
    testCompileOnly 'org.projectlombok:lombok'
    testAnnotationProcessor 'org.projectlombok:lombok'

    //testcontainers
    testImplementation "org.testcontainers:testcontainers:1.19.0"
    testImplementation "org.testcontainers:junit-jupiter:1.19.0"
    testImplementation "org.testcontainers:mariadb:1.19.0"

    //test
    testImplementation 'org.springframework.cloud:spring-cloud-contract-wiremock' // For @AutoConfigureWireMock
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    testImplementation 'org.springframework.security:spring-security-test'
}

Build

0. Requirement

   • Docker Engine
   • Java 17 or higher

1. Before build and run application, you should set up database with the information below

   • Jdbc url: jdbc:mariadb://localhost:3306/trecord
   • Username: root
   • Password: 1234

2. After you set database

   • create schema named trecord
   • and run ./database/service-domain-create.sql in trecord

3. After you set schema, run command below in your terminal

./gradlew clean build && java -jar build/libs/*.jar

External APIs in use

The following APIs are being invoked for Google Oauth2 authentication

• POST https://oauth2.googleapis.com/token
• GET https://www.googleapis.com/oauth2/v3/userinfo

Ref: https://developers.google.com/identity/protocols/oauth2/web-server?hl=ko#exchange-authorization-code

ERD

AWS Architecture

Git flow

|-- master
|   |-- hotfix
|   |   |-- #885
|-- develop
|   |-- feat
|   |   |-- #883
|   |   |-- #884
|   |-- refactor
|   |   |-- #887