Merge pull request #738 from woowacourse-teams/refactor/650-code-conv…

…entions-check 전반적으로 자잘한 코드 컨벤션 정리
woowacourse-teams · Oct 10, 2024 · bbafbd3 · bbafbd3
2 parents 7468bda + 75f7df2
commit bbafbd3
Show file tree

Hide file tree

Showing 27 changed files with 75 additions and 64 deletions.
diff --git a/backend/src/main/java/codezap/global/cors/CorsProperties.java b/backend/src/main/java/codezap/global/cors/CorsProperties.java
@@ -4,8 +4,12 @@
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.bind.DefaultValue;
 
+import lombok.Getter;
+
+@Getter
 @ConfigurationProperties(prefix = "cors")
 public class CorsProperties {
+
     private final String[] allowedOrigins;
     private final String[] allowedOriginsPatterns;
 
@@ -16,12 +20,4 @@ public CorsProperties(
         this.allowedOrigins = allowedOrigins;
         this.allowedOriginsPatterns = allowedOriginsPatterns;
     }
-
-    public String[] getAllowedOrigins() {
-        return allowedOrigins;
-    }
-
-    public String[] getAllowedOriginsPatterns() {
-        return allowedOriginsPatterns;
-    }
 }
diff --git a/backend/src/main/java/codezap/global/exception/CodeZapException.java b/backend/src/main/java/codezap/global/exception/CodeZapException.java
@@ -6,6 +6,7 @@
 
 @Getter
 public class CodeZapException extends RuntimeException {
+
     private final HttpStatusCode httpStatusCode;
 
     public CodeZapException(HttpStatusCode httpStatusCode, String message) {

diff --git a/backend/src/main/java/codezap/global/rds/DataSourceRouter.java b/backend/src/main/java/codezap/global/rds/DataSourceRouter.java
@@ -12,7 +12,7 @@ public class DataSourceRouter extends AbstractRoutingDataSource {
     protected Object determineCurrentLookupKey() {
         boolean readOnly = TransactionSynchronizationManager.isCurrentTransactionReadOnly();
 
-        if(readOnly) {
+        if (readOnly) {
             return READER_KEY;
         }
         return WRITER_KEY;

diff --git a/backend/src/main/java/codezap/global/serialization/DateTimeFormatConfiguration.java b/backend/src/main/java/codezap/global/serialization/DateTimeFormatConfiguration.java
@@ -10,6 +10,7 @@
 
 @Configuration
 public class DateTimeFormatConfiguration {
+
     private static final String DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
 
     @Bean

diff --git a/backend/src/main/java/codezap/global/swagger/AuthOperationCustomizer.java b/backend/src/main/java/codezap/global/swagger/AuthOperationCustomizer.java
@@ -27,6 +27,7 @@
  */
 @Component
 public class AuthOperationCustomizer implements OperationCustomizer {
+
     private static final ObjectMapper objectMapper = new ObjectMapper();
 
     @Override

diff --git a/backend/src/main/java/codezap/global/swagger/error/ApiErrorResponses.java b/backend/src/main/java/codezap/global/swagger/error/ApiErrorResponses.java
@@ -8,5 +8,6 @@
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface ApiErrorResponses {
+
     ApiErrorResponse[] value();
 }
diff --git a/backend/src/main/java/codezap/global/swagger/error/ApiErrorResponsesCustomizer.java b/backend/src/main/java/codezap/global/swagger/error/ApiErrorResponsesCustomizer.java
@@ -20,6 +20,7 @@
 
 @Component
 public class ApiErrorResponsesCustomizer implements OperationCustomizer {
+
     @Override
     public Operation customize(Operation operation, HandlerMethod handlerMethod) {
         List<ApiErrorResponse> apiErrorResponses = getApiErrorResponses(handlerMethod);

diff --git a/backend/src/main/java/codezap/global/validation/ValidationGroups.java b/backend/src/main/java/codezap/global/validation/ValidationGroups.java
@@ -1,6 +1,7 @@
 package codezap.global.validation;
 
 public class ValidationGroups {
+
     public interface NotNullGroup {}
 
     public interface SourceCodeOrdinalGroup {}

diff --git a/backend/src/main/java/codezap/likes/repository/LikesRepository.java b/backend/src/main/java/codezap/likes/repository/LikesRepository.java
@@ -7,6 +7,7 @@
 import codezap.template.domain.Template;
 
 public interface LikesRepository {
+
     Likes save(Likes likes);
 
     boolean existsByMemberAndTemplate(Member member, Template template);

diff --git a/backend/src/main/java/codezap/tag/controller/SpringDocTagController.java b/backend/src/main/java/codezap/tag/controller/SpringDocTagController.java
@@ -10,6 +10,7 @@
 
 @Tag(name = "태그 API", description = "태그 조회 API")
 public interface SpringDocTagController {
+
     @SecurityRequirement(name = "쿠키 인증 토큰")
     @Operation(summary = "태그 조회", description = "해당 멤버의 템플릿들에 포함된 태그를 조회합니다.")
     @ApiResponse(responseCode = "200", description = "태그 조회 성공")

diff --git a/backend/src/main/java/codezap/tag/repository/TemplateTagJpaRepository.java b/backend/src/main/java/codezap/tag/repository/TemplateTagJpaRepository.java
@@ -23,19 +23,19 @@ public interface TemplateTagJpaRepository extends TemplateTagRepository, JpaRepo
     List<Tag> findAllTagsByTemplate(Template template);
 
     @Query("""
-        SELECT tt, t
-        FROM TemplateTag tt
-        JOIN FETCH tt.tag t
-        WHERE tt.id.templateId = :templateId
-        """)
+            SELECT tt, t
+            FROM TemplateTag tt
+            JOIN FETCH tt.tag t
+            WHERE tt.id.templateId = :templateId
+            """)
     List<TemplateTag> findAllByTemplateId(Long templateId);
 
     @Query("""
-        SELECT tt, t
-        FROM TemplateTag tt
-        JOIN FETCH tt.tag t
-        WHERE tt.id.templateId in :templateIds
-        """)
+            SELECT tt, t
+            FROM TemplateTag tt
+            JOIN FETCH tt.tag t
+            WHERE tt.id.templateId in :templateIds
+            """)
     List<TemplateTag> findAllByTemplateIdsIn(List<Long> templateIds);
 
     @Query("""
@@ -44,10 +44,11 @@ public interface TemplateTagJpaRepository extends TemplateTagRepository, JpaRepo
             WHERE t.id IN (
                 SELECT DISTINCT tt.id.tagId
                 FROM TemplateTag tt
-                WHERE tt.id.templateId IN
-                    (SELECT te.id FROM Template te WHERE te.member.id = :memberId)
-        )
-        """)
+                WHERE tt.id.templateId IN (
+                    SELECT te.id FROM Template te WHERE te.member.id = :memberId
+                )
+            )
+            """)
     List<Tag> findAllTagDistinctByMemberId(Long memberId);
 
     @Modifying(clearAutomatically = true)

diff --git a/backend/src/main/java/codezap/tag/repository/TemplateTagRepository.java b/backend/src/main/java/codezap/tag/repository/TemplateTagRepository.java
@@ -16,8 +16,6 @@ public interface TemplateTagRepository {
 
     List<TemplateTag> findAllByTemplateId(Long templateId);
 
-    List<Long> findDistinctByTemplateIn(List<Long> templateIds);
-
     List<TemplateTag> findAllByTemplateIdsIn(List<Long> templateIds);
 
     TemplateTag save(TemplateTag templateTag);

diff --git a/backend/src/main/java/codezap/template/controller/SpringDocTemplateController.java b/backend/src/main/java/codezap/template/controller/SpringDocTemplateController.java
@@ -27,7 +27,7 @@ public interface SpringDocTemplateController {
             새로운 템플릿을 생성합니다. \n
             템플릿명, 템플릿 설명, 소스 코드 목록, 썸네일 순서, 카테고리 ID, 태그 목록이 필요합니다. \n
             * 템플릿 이름은 비어있거나 공백일 수 없다.
-            
+                        
             소스 코드 목록은 파일명, 소스 코드, 소스 코드 순서가 필요합니다. \n
             * 소스 코드 순서는 1부터 시작합니다.
             * 소스 코드 순서는 오름차순으로 정렬하여 보내야 합니다.
@@ -62,13 +62,13 @@ public interface SpringDocTemplateController {
               - 검색 키워드 (템플릿명, 템플릿 설명, 파일명, 소스 코드)
               - 카테고리 ID
               - 태그 ID들 \n
-            
+                        
             페이징 조건을 줄 수 있습니다. 페이지 번호는 1, 템플릿 개수는 20, 정렬 방식은 최신순이 기본 값입니다. \n
             - 페이징 조건 \n
               - 페이지 번호(pageNumber)
               - 한 페이지에 템플릿 개수(pageSize)
               - 페이지 정렬 방식(sort) \n
-            
+                        
             - 정렬 방식 \n
               - 최신순 (modifiedAt,asc)
               - 오래된순 (modifiedAt,desc)
@@ -102,13 +102,13 @@ ResponseEntity<FindAllTemplatesResponse> findAllTemplates(
               - 검색 키워드 (템플릿명, 템플릿 설명, 파일명, 소스 코드)
               - 카테고리 ID
               - 태그 ID들 \n
-            
+                        
             페이징 조건을 줄 수 있습니다. 페이지 번호는 1, 템플릿 개수는 20, 정렬 방식은 최신순이 기본 값입니다. \n
             - 페이징 조건 \n
               - 페이지 번호(pageNumber)
               - 한 페이지에 템플릿 개수(pageSize)
               - 페이지 정렬 방식(sort) \n
-            
+                        
             - 정렬 방식 \n
               - 최신순 (modifiedAt,asc)
               - 오래된순 (modifiedAt,desc)

diff --git a/backend/src/main/java/codezap/template/repository/FullTextSearchMySQLDialect.java b/backend/src/main/java/codezap/template/repository/FullTextSearchMySQLDialect.java
@@ -32,7 +32,12 @@ public ExactPhraseMatchFunction() {
         }
 
         @Override
-        public void render(SqlAppender sqlAppender, List<? extends SqlAstNode> arguments, ReturnableType<?> returnType, SqlAstTranslator<?> translator) {
+        public void render(
+                SqlAppender sqlAppender,
+                List<? extends SqlAstNode> arguments,
+                ReturnableType<?> returnType,
+                SqlAstTranslator<?> translator
+        ) {
             sqlAppender.appendSql("MATCH(");
             translator.render(arguments.get(0), SqlAstNodeRenderingMode.DEFAULT);
             sqlAppender.appendSql(", ");

diff --git a/backend/src/main/java/codezap/template/repository/SourceCodeJpaRepository.java b/backend/src/main/java/codezap/template/repository/SourceCodeJpaRepository.java
@@ -14,6 +14,7 @@
 
 @SuppressWarnings("unused")
 public interface SourceCodeJpaRepository extends SourceCodeRepository, JpaRepository<SourceCode, Long> {
+
     default SourceCode fetchById(Long id) {
         return findById(id).orElseThrow(
                 () -> new CodeZapException(HttpStatus.NOT_FOUND, "식별자 " + id + "에 해당하는 소스 코드가 존재하지 않습니다."));

diff --git a/backend/src/main/java/codezap/template/repository/SourceCodeRepository.java b/backend/src/main/java/codezap/template/repository/SourceCodeRepository.java
@@ -7,6 +7,7 @@
 import codezap.template.domain.Template;
 
 public interface SourceCodeRepository {
+
     SourceCode fetchById(Long id);
 
     List<SourceCode> findAllByTemplate(Template template);

diff --git a/backend/src/main/java/codezap/template/repository/TemplateSpecification.java b/backend/src/main/java/codezap/template/repository/TemplateSpecification.java
@@ -17,6 +17,7 @@
 import codezap.template.domain.TemplateTag;
 
 public class TemplateSpecification implements Specification<Template> {
+
     private final Long memberId;
     private final String keyword;
     private final Long categoryId;

diff --git a/backend/src/main/java/codezap/template/repository/ThumbnailJpaRepository.java b/backend/src/main/java/codezap/template/repository/ThumbnailJpaRepository.java
@@ -23,11 +23,11 @@ default Thumbnail fetchByTemplate(Template template) {
     }
 
     @Query("""
-        SELECT t, sc
-        FROM Thumbnail t
-        join fetch t.sourceCode sc
-        WHERE t.template = :template
-        """)
+            SELECT t, sc
+            FROM Thumbnail t
+            join fetch t.sourceCode sc
+            WHERE t.template = :template
+            """)
     Optional<Thumbnail> findByTemplate(Template template);
 
 

diff --git a/backend/src/test/java/codezap/auth/manager/CookieCredentialManagerTest.java b/backend/src/test/java/codezap/auth/manager/CookieCredentialManagerTest.java
@@ -22,7 +22,6 @@ class CookieCredentialManagerTest {
 
     private MockHttpServletRequest request;
     private MockHttpServletResponse response;
-
     private CookieCredentialManager cookieCredentialManager;
 
     @BeforeEach
@@ -34,7 +33,7 @@ void setUp() {
 
     @Nested
     @DisplayName("인증 정보 반환")
-    class getCredential {
+    class GetCredential {
 
         @Test
         @DisplayName("인증 정보 반환 성공")

diff --git a/backend/src/test/java/codezap/auth/provider/basic/BasicAuthCredentialProviderTest.java b/backend/src/test/java/codezap/auth/provider/basic/BasicAuthCredentialProviderTest.java
@@ -43,7 +43,8 @@ void createCredential() {
 
     @Nested
     @DisplayName("인증 정보로부터 회원 추출")
-    class extractMember {
+    class ExtractMember {
+
         @Test
         @DisplayName("회원 추출 성공")
         void extractMember() {

diff --git a/backend/src/test/java/codezap/auth/service/AuthServiceTest.java b/backend/src/test/java/codezap/auth/service/AuthServiceTest.java
@@ -17,8 +17,6 @@
 import codezap.auth.dto.LoginAndCredentialDto;
 import codezap.auth.dto.request.LoginRequest;
 import codezap.auth.dto.response.LoginResponse;
-import codezap.auth.encryption.PasswordEncryptor;
-import codezap.auth.encryption.SHA2PasswordEncryptor;
 import codezap.auth.provider.CredentialProvider;
 import codezap.global.DatabaseIsolation;
 import codezap.global.exception.CodeZapException;
@@ -29,6 +27,7 @@
 @SpringBootTest
 @DatabaseIsolation
 public class AuthServiceTest {
+
     @Autowired
     private MemberRepository memberRepository;
 

diff --git a/backend/src/test/java/codezap/category/controller/CategoryControllerTest.java b/backend/src/test/java/codezap/category/controller/CategoryControllerTest.java
@@ -40,7 +40,7 @@ class CategoryControllerTest extends MockMvcTest {
 
     @Nested
     @DisplayName("카테고리 생성 테스트")
-    class createCategoryTest {
+    class CreateCategoryTest {
 
         @Test
         @DisplayName("카테고리 생성 성공")
@@ -109,7 +109,7 @@ void findAllCategoriesSuccess() throws Exception {
 
     @Nested
     @DisplayName("카테고리 수정 테스트")
-    class updateCategoryTest {
+    class UpdateCategoryTest {
 
         @Test
         @DisplayName("카테고리 수정 성공")
@@ -174,7 +174,7 @@ void updateCategoryFailWithDuplicatedName() throws Exception {
 
     @Nested
     @DisplayName("카테고리 삭제 테스트")
-    class deleteCategoryTest {
+    class DeleteCategoryTest {
 
         @Test
         @DisplayName("카테고리 삭제 성공")
@@ -205,7 +205,7 @@ void deleteCategoryFailWithUnauthorized() throws Exception {
 
         @Test
         @DisplayName("카테고리 삭제 실패: 존재하지 않는 카테고리의 삭제 요청")
-        void updateCategoryFailWithDuplicatedName() throws Exception {
+        void deleteCategoryFailWithDuplicatedName() throws Exception {
             long id = 2L;
 
             doThrow(new CodeZapException(HttpStatus.NOT_FOUND, "식별자 " + id + "에 해당하는 카테고리가 존재하지 않습니다."))
@@ -220,7 +220,7 @@ void updateCategoryFailWithDuplicatedName() throws Exception {
 
         @Test
         @DisplayName("카테고리 삭제 실패: 템플릿이 존재하는 카테고리는 삭제 불가능")
-        void updateCategoryFailWithlongName() throws Exception {
+        void deleteCategoryFailWithlongName() throws Exception {
             long categoryId = 1L;
             doThrow(new CodeZapException(HttpStatus.BAD_REQUEST, "템플릿이 존재하는 카테고리는 삭제할 수 없습니다."))
                     .when(categoryService).deleteById(any(), any());

diff --git a/backend/src/test/java/codezap/member/repository/MemberJpaRepositoryTest.java b/backend/src/test/java/codezap/member/repository/MemberJpaRepositoryTest.java
@@ -32,7 +32,8 @@ class MemberJpaRepositoryTest {
 
     @Nested
     @DisplayName("id로 Member 조회")
-    class fetchById {
+    class FetchById {
+
         @Test
         @DisplayName("성공 : id로 Member 조회 가능")
         void fetchByIdSuccess() {
@@ -56,7 +57,8 @@ void fetchByIdFailByNotExistsId() {
 
     @Nested
     @DisplayName("닉네임(아이디)로 Member 조회")
-    class fetchByName {
+    class FetchByName {
+
         @Test
         @DisplayName("성공 : 닉네임으로 Member 조회 가능")
         void fetchByNameSuccess() {
@@ -80,7 +82,8 @@ void fetchByNameFailByNotExistsId() {
 
     @Nested
     @DisplayName("템플릿 id로 Member 조회")
-    class fetchByTemplateId {
+    class FetchByTemplateId {
+
         @Test
         @DisplayName("성공 : 템플릿 id로 Member 조회 가능")
         void fetchByTemplateIdSuccess() {
@@ -106,7 +109,8 @@ void fetchByTemplateIdFailByNotExistsId() {
 
     @Nested
     @DisplayName("닉네임(아이디) 존재 여부")
-    class existsByName {
+    class ExistsByName {
+
         @Test
         @DisplayName("성공 : 해당 닉네임이 존재하면 true를 반환")
         void existsByNameReturnTrue() {