Merge branch 'BE_develop'

.github/workflows/main.yml

@@ -6,6 +6,7 @@ on:
       - main
       - AND_develop
       - BE_develop
+      - FE_develop
 
 jobs:
   push-to-gitlab:

backEnd/.gitignore

@@ -36,4 +36,5 @@ out/
 ### VS Code ###
 .vscode/
 
-application-key.yml
+application-key.yml
+ulvan-firebase-key.json

backEnd/README.md

@@ -0,0 +1,70 @@
+# 울반 - NFC기반 학급 소통 앱
+![](https://blog.kakaocdn.net/dn/kTWTG/btsHtPbRbMO/ApDuCfEaKyqA57ZlnGnkU0/img.png)
+
+<div>
+<h4>📱 NFC, 블루투스 기반으로 소통해요<h4> 
+
+<h4>🎯 친구들과 채팅하고 글을 쓰며 일상을 공유해요<h4>
+
+<h4>👥 친구들과의 친밀도를 확인해요<h4>
+
+<h4>🥇 선생님은 학생들의 소통 통계를 확인해요<h4>
+</div>
+<br/>
+
+## 개요
+
+- **한 줄 요약** : *울반* 프로젝트는 NFC와 BLE 통신을 기반으로 한 학급 소통 앱입니다.
+
+- **기획의도** : 코로나 이후 악화된 교우관개를 개선을 위해 제작되었습니다.
+
+- **개발 인원 및 기간**
+
+  - **개발 인원** : Android 3명, BackEnd 3명
+
+  - **프로젝트 기간** : 2024.04.08 ~ 2024.05.19
+
+- **주요 기능**
+
+  - NFC 기반의 태깅인사, 이어달리기
+
+  - 블루투스 기반의 함께달리기
+
+  - 학급별 채팅, 게시판, 알림장
+
+  - 학급별 소통 통계
+
+<br/><br/><br/><br/>
+
+
+# 시스템 아키텍처
+![자율울반](https://github.com/6QuizOnTheBlock/OurClass/assets/74866067/236444d6-b74f-4859-af46-993a3f4410ec)
+
+# ERD
+![울반 ERD (1)](https://github.com/6QuizOnTheBlock/OurClass/assets/74866067/488849f1-1778-4472-a77b-8ea5cd4c70d8)
+
+
+### 기술
+
+- Java21, Spring Boot 3.2
+- Spring Security + JWT + Oauth2
+- Spring Data JPA, Query DSL
+- MySQL, Redis, MongoDB
+- AWS ec2
+- Jenkins, Docker
+- kafka
+- Swagger, Rest api
+
+<br/><br/><br/><br/>
+
+
+# 동작 화면
+
+**주요 동작화면은 추후 추가 예정입니다.**
+
+### [피그마](https://www.figma.com/design/yfm5gTmRJED2uAdm7H70YC/6-kids-on-the-block?node-id=0%3A1&t=5blyLSniokJVPpQR-1)
+
+
+<br/><br/><br/>
+
+## 역할

backEnd/build.gradle

@@ -2,6 +2,15 @@ plugins {
     id 'java'
     id 'org.springframework.boot' version '3.2.5'
     id 'io.spring.dependency-management' version '1.1.4'
+    id 'org.sonarqube' version '4.0.0.2929'
+}
+
+sonarqube {
+    properties {
+        property "sonar.projectKey", System.getenv('SONAR_PROJECT_KEY')
+        property "sonar.host.url", System.getenv('SONAR_HOST_URL')
+        property "sonar.login", System.getenv('SONAR_LOGIN')
+    }
 }
 
 group = 'com.6quiz'
@@ -11,6 +20,10 @@ java {
     sourceCompatibility = '21'
 }
 
+ext {
+    springCloudVersion = '2023.0.1'
+}
+
 configurations {
     compileOnly {
         extendsFrom annotationProcessor
@@ -21,20 +34,92 @@ repositories {
     mavenCentral()
 }
 
+dependencyManagement {
+    imports {
+        mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
+    }
+}
+
+
 dependencies {
+
+    // ⭐ Spring Basic Setting
     implementation 'org.springframework.boot:spring-boot-starter-web'
-    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
-    implementation 'org.springframework.boot:spring-boot-starter-data-mongodb'
-    implementation 'org.springframework.boot:spring-boot-starter-data-redis'
+    implementation 'org.springframework.boot:spring-boot-starter-security'
+    testImplementation 'org.springframework.security:spring-security-test'
     compileOnly 'org.projectlombok:lombok'
+    implementation group: 'org.springframework', name: 'spring-aop', version: '6.1.6'
     developmentOnly 'org.springframework.boot:spring-boot-devtools'
-    implementation 'com.github.ulisesbocchio:jasypt-spring-boot-starter:3.0.5'
     annotationProcessor 'org.projectlombok:lombok'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
+
+    // ⭐ Database
+    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
+    implementation 'org.springframework.boot:spring-boot-starter-data-mongodb'
+    implementation 'org.springframework.boot:spring-boot-starter-data-redis'
     runtimeOnly 'com.mysql:mysql-connector-j'
+
+    // ⭐ Firebase
+    implementation 'com.google.firebase:firebase-admin:9.1.1'
+
+    // ⭐ Jasypt
+    implementation 'com.github.ulisesbocchio:jasypt-spring-boot-starter:3.0.5'
+
+    // ⭐ SWAGGER
+    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0'
+
+    // ⭐ AWS
+    implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'
+
+    // ⭐ QueryDsl
+    implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
+    annotationProcessor "com.querydsl:querydsl-apt:5.0.0:jakarta"
+    annotationProcessor "jakarta.annotation:jakarta.annotation-api"
+    annotationProcessor "jakarta.persistence:jakarta.persistence-api"
+
+    // ⭐ MapStruct
+    implementation 'org.mapstruct:mapstruct:1.5.3.Final'
+    annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.3.Final'
+
+    // ⭐ JWT (현: 0.11.5  -> 0.12.3 migration 예정)
+    implementation group: 'io.jsonwebtoken', name: 'jjwt-api', version: '0.11.5'
+    runtimeOnly group: 'io.jsonwebtoken', name: 'jjwt-impl', version: '0.11.5'
+    runtimeOnly group: 'io.jsonwebtoken', name: 'jjwt-jackson', version: '0.11.5'
+    implementation group: 'io.jsonwebtoken', name: 'jjwt-jackson', version: '0.11.5'
+
+    // ⭐ feign Client
+    implementation 'org.springframework.cloud:spring-cloud-starter-openfeign'
+
+    // ⭐ Cache
+    implementation 'org.springframework.boot:spring-boot-starter-cache'
+
+    // ⭐ WebSocket
+    implementation 'org.springframework.boot:spring-boot-starter-websocket'
+
+    // ⭐ kafka
+    implementation 'org.springframework.kafka:spring-kafka'
+    implementation 'org.apache.kafka:kafka-clients'
+    implementation 'org.springframework.retry:spring-retry'
+
+    implementation 'org.ojalgo:ojalgo:51.4.1'
+
 }
 
 tasks.named('test') {
     useJUnitPlatform()
     systemProperty 'jasypt.encryptor.key', findProperty("jasypt.encryptor.key")
 }
+
+//Q객체 저장위치
+def querydslDir = layout.buildDirectory.dir("generated/querydsl").get().asFile
+
+sourceSets {
+    main.java.srcDirs += [querydslDir]
+}
+tasks.withType(JavaCompile).configureEach {
+    options.getGeneratedSourceOutputDirectory().set(file(querydslDir))
+    options.compilerArgs << "-parameters"
+}
+clean {
+    delete file(querydslDir)
+}

backEnd/src/main/java/com/quiz/ourClass/OurClassApplication.java → backEnd/src/main/java/com/quiz/ourclass/OurClassApplication.java

@@ -1,4 +1,4 @@
-package com.quiz.ourClass;
+package com.quiz.ourclass;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

backEnd/src/main/java/com/quiz/ourclass/domain/board/controller/CommentController.java

@@ -0,0 +1,52 @@
+package com.quiz.ourclass.domain.board.controller;
+
+import com.quiz.ourclass.domain.board.dto.request.CommentRequest;
+import com.quiz.ourclass.domain.board.dto.request.UpdateCommentRequest;
+import com.quiz.ourclass.domain.board.sevice.CommentService;
+import com.quiz.ourclass.global.dto.ResultResponse;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.PatchMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/comments")
+public class CommentController implements CommentControllerDocs {
+
+    private final CommentService commentService;
+
+    @PostMapping
+    public ResponseEntity<ResultResponse<Long>> write(
+        @RequestBody CommentRequest request) {
+        Long commentId = commentService.write(request);
+        return ResponseEntity.ok(ResultResponse.success(commentId));
+    }
+
+    @PatchMapping("/{id}")
+    public ResponseEntity<ResultResponse<Long>> modify(
+        @PathVariable(value = "id") Long id,
+        @RequestBody UpdateCommentRequest request) {
+        Long commentId = commentService.modify(id, request);
+        return ResponseEntity.ok(ResultResponse.success(commentId));
+    }
+
+    @DeleteMapping("/{id}")
+    public ResponseEntity<ResultResponse<Boolean>> delete(
+        @PathVariable(value = "id") Long id) {
+        Boolean isDelete = commentService.delete(id);
+        return ResponseEntity.ok(ResultResponse.success(isDelete));
+    }
+
+    @PostMapping("/{id}/report")
+    public ResponseEntity<ResultResponse<Boolean>> report(
+        @PathVariable(value = "id") Long id) {
+        Boolean isReport = commentService.report(id);
+        return ResponseEntity.ok(ResultResponse.success(isReport));
+    }
+}

backEnd/src/main/java/com/quiz/ourclass/domain/board/controller/CommentControllerDocs.java

@@ -0,0 +1,113 @@
+package com.quiz.ourclass.domain.board.controller;
+
+import com.quiz.ourclass.domain.board.dto.request.CommentRequest;
+import com.quiz.ourclass.domain.board.dto.request.UpdateCommentRequest;
+import com.quiz.ourclass.global.dto.ResultResponse;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.PatchMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+
+@Tag(name = "CommentController", description = "SNS 댓글 API")
+public interface CommentControllerDocs {
+
+    @Operation(summary = "댓글 작성",
+        description = """
+            입력으로 들어오는 DTO 기준으로 댓글을 작성합니다.
+            이때, 부모 댓글은 parentId 값에 0L을 보내주세요!""",
+        responses = {
+            @ApiResponse(responseCode = "200", description = "(message : \"Success\")",
+                content = @Content(schema = @Schema(implementation = Long.class))),
+            @ApiResponse(responseCode = "403", description = """
+                (message : "멤버가 해당 단체 소속이 아닙니다.")
+                                
+                (message : "게시글 작성자 단체와 현재 사용자 단체가 다릅니다.")
+                """, content = @Content),
+            @ApiResponse(responseCode = "404", description = """
+                (message : "멤버가 존재하지 않습니다.")
+                                
+                (message : "게시글을 찾을 수 없습니다.")
+                                
+                (message : "두 멤버간의 관계를 찾을 수 없습니다.")
+                """, content = @Content),
+        }
+    )
+    @PostMapping
+    ResponseEntity<ResultResponse<Long>> write(
+        @Parameter(name = "request", description = "댓글 작성 DTO", required = true, in = ParameterIn.DEFAULT)
+        @RequestBody CommentRequest request
+    );
+
+    @Operation(summary = "댓글 수정",
+        description = "입력으로 들어오는 DTO 기준으로 댓글을 수정합니다.",
+        responses = {
+            @ApiResponse(responseCode = "200", description = "(message : \"Success\")",
+                content = @Content(schema = @Schema(implementation = Long.class))),
+            @ApiResponse(responseCode = "403", description = "(message : \"댓글 작성자 단체와 현재 사용자 단체가 다릅니다.\")", content = @Content),
+            @ApiResponse(responseCode = "404", description = """
+                (message : "멤버가 존재하지 않습니다.")
+                                
+                (message : "댓글을 찾을 수 없습니다.")
+                """, content = @Content),
+        }
+    )
+    @PatchMapping("/{id}")
+    ResponseEntity<ResultResponse<Long>> modify(
+        @Parameter(name = "id", description = "댓글 PK 값", required = true, in = ParameterIn.PATH)
+        @PathVariable(value = "id") Long id,
+        @Parameter(name = "request", description = "댓글 수정 DTO", required = true, in = ParameterIn.DEFAULT)
+        @RequestBody UpdateCommentRequest request
+    );
+
+    @Operation(summary = "댓글 삭제",
+        description = "입력으로 들어오는 댓글 PK 기준으로 댓글을 삭제합니다.",
+        responses = {
+            @ApiResponse(responseCode = "200", description = "(message : \"Success\")",
+                content = @Content(schema = @Schema(implementation = Boolean.class))),
+            @ApiResponse(responseCode = "403", description = """
+                (message : "댓글 작성자와 요청자가 다릅니다.")
+                                
+                (message : "멤버가 해당 단체 소속이 아닙니다.")
+                """, content = @Content),
+            @ApiResponse(responseCode = "404", description = "(message : \"댓글을 찾을 수 없습니다.\")", content = @Content)
+        }
+    )
+    @DeleteMapping("/{id}")
+    ResponseEntity<ResultResponse<Boolean>> delete(
+        @Parameter(name = "id", description = "댓글 PK 값", required = true, in = ParameterIn.PATH)
+        @PathVariable(value = "id") Long id
+    );
+
+    @Operation(
+        summary = "댓글 신고",
+        description = "path 입력으로 들어온 게시글 PK 값 기준으로 댓을 신고하여 해당 단체 관리자에게 FCM 알림을 전송합니다.",
+        responses = {
+            @ApiResponse(responseCode = "200", description = "(message : \"Success\")",
+                content = @Content(schema = @Schema(implementation = Boolean.class))),
+            @ApiResponse(responseCode = "403", description = """
+                (message : "멤버가 해당 단체 소속이 아닙니다.")
+                                
+                (message : "단체 관리자는 신고할 수 없습니다.")
+                """, content = @Content),
+            @ApiResponse(responseCode = "404", description = """
+                (message : "멤버가 존재하지 않습니다.")
+                                
+                (message : "댓글을 찾을 수 없습니다.")
+                """, content = @Content),
+        }
+    )
+    @PostMapping("/{id}/report")
+    ResponseEntity<ResultResponse<Boolean>> report(
+        @Parameter(name = "id", description = "댓글 PK 값", required = true, in = ParameterIn.PATH)
+        @PathVariable(value = "id") Long id
+    );
+}