Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat : 뿌리오 메시지 관련 로직 일부 #26

Closed
wants to merge 2 commits into from
Closed

feat : 뿌리오 메시지 관련 로직 일부 #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb1b0fa
feat : 뿌리오 메시지 관련 로직 일부
lsh1215 Nov 4, 2024
947b0d2
test(yml) : build test를 위한 설정
lsh1215 Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions src/main/java/com/pictalk/message/controller/MessageController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package com.pictalk.message.controller;

import com.pictalk.message.dto.MessageRequestDto;
import com.pictalk.message.service.MessageService;
import lombok.RequiredArgsConstructor;
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("/messages")
public class MessageController {

private final MessageService messageService;

// 메시지 발송
@PostMapping
public void sendMessage(@RequestBody MessageRequestDto.CommonMessage commonMessage) {
// 메시지 전송 로직
messageService.requestSend(commonMessage);
}

// @PostMapping
// public void kkaoSendMessage(@RequestBody MessageRequestDto.kkaoMessage kkaoMessage) {
// // 카카오 메시지 전송 로직
// messageService.requestSend(kkaoMessage);
// }

}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

코드에서 수정이 필요하거나 개선할 수 있는 부분은 다음과 같습니다.

  1. 메소드 분리: 현재 sendMessage 메소드가 commonMessage와 카카오 메시지 모두를 처리하려는 의도가 보입니다. 각 메시지 유형에 대한 메소드를 명확히 분리하는 것이 좋습니다. 주석 처리된 kkaoSendMessage 메소드를 복원하고, 두 메소드를 별도로 유지하세요.

  2. HTTP 응답 상태 코드: 현재 sendMessage 메소드는 HTTP 응답을 반환하지 않습니다. 성공적인 요청에는 ResponseEntity를 이용해 적절한 상태 코드(예: 201 Created)를 반환하는 것이 좋습니다.

  3. 예외 처리: 메시지 발송 중 오류가 발생할 경우 사용할 예외 처리가 없습니다. @ControllerAdvice 또는 특정 예외 핸들러를 통해 사용자 친화적인 에러 메시지와 적절한 상태 코드를 반환하도록 개선할 수 있습니다.

  4. DTO 클래스 패키지 구조: DTO 클래스 이름(MessageRequestDto.CommonMessage, MessageRequestDto.kkaoMessage)이 사용하기에 가독성이 떨어질 수 있습니다. 각 메시지 타입에 대해 별도의 DTO 클래스를 만드는 것을 검토해보세요.

  5. API 문서화: Swagger 등의 도구를 활용하여 API 문서화를 진행하면 클라이언트와의 통신 시 이해도를 높일 수 있습니다.

수정된 코드 예시는 다음과 같습니다:

@RestController
@RequiredArgsConstructor
@RequestMapping("/messages")
public class MessageController {

    private final MessageService messageService;

    // 메시지 발송
    @PostMapping("/common")
    public ResponseEntity<Void> sendCommonMessage(@RequestBody MessageRequestDto.CommonMessage commonMessage) {
        messageService.requestSend(commonMessage);
        return ResponseEntity.status(HttpStatus.CREATED).build();
    }

    // 카카오 메시지 발송
    @PostMapping("/kakao")
    public ResponseEntity<Void> sendKakaoMessage(@RequestBody MessageRequestDto.KakaoMessage kakaoMessage) {
        messageService.requestSend(kakaoMessage);
        return ResponseEntity.status(HttpStatus.CREATED).build();
    }
}

위와 같이 개선하여 코드의 가독성과 유지보수성을 높일 수 있습니다.

21 changes: 21 additions & 0 deletions src/main/java/com/pictalk/message/domain/Request.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
package com.pictalk.message.domain;

public class Request {

private String requestUri;
private String authorization;

public Request(String requestUri, String authorization) {
this.requestUri = requestUri;
this.authorization = authorization;
}

public String getRequestUri() {
return requestUri;
}

public String getAuthorization() {
return authorization;
}

}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

코드는 전반적으로 잘 작성되어 있습니다. 하지만 몇 가지 개선 사항을 제안합니다.

  1. 불변성(Immutable): 객체의 상태를 변경할 수 없도록 하는 것이 좋습니다. Request 클래스의 필드를 final로 선언하여 불변성을 보장할 수 있습니다.

    private final String requestUri;
private final String authorization;

  2. 공백 및 들여쓰기: Java에서는 일반적으로 클래스의 멤버 변수 선언과 메소드 간에 줄 바꿈을 사용하는 것이 좋으므로 가독성을 높일 수 있습니다.

  3. Override toString() 메소드: 객체를 로그하거나 디버그할 때 유용하도록 toString() 메소드를 오버라이드하는 것을 고려해보세요.

    @Override
public String toString() {
    return "Request{" +
            "requestUri='" + requestUri + '\'' +
            ", authorization='" + authorization + '\'' +
            '}';
}

  4. Null 체크: 생성자에서 null 값을 전달받는 경우를 처리할 수 있도록 예외 처리를 추가하면 더 안전합니다.

    public Request(String requestUri, String authorization) {
    if (requestUri == null || authorization == null) {
        throw new IllegalArgumentException("URI and authorization cannot be null");
    }
    this.requestUri = requestUri;
    this.authorization = authorization;
}

이러한 점들을 반영하면 코드의 안정성과 가독성을 높일 수 있습니다.

54 changes: 54 additions & 0 deletions src/main/java/com/pictalk/message/dto/MessageRequestDto.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
package com.pictalk.message.dto;

import java.util.List;
import java.util.Map;
import lombok.AllArgsConstructor;
import lombok.Getter;

public class MessageRequestDto {

@Getter
@AllArgsConstructor
public static class CommonMessage {
private String messageType;
private String content;
private String from;
private String duplicateFlag;
private int targetCount;
private List<TargetDto> targets;
private String refKey;
private String rejectType;
private String sendTime;
private String subject;
private List<FileDto> files;

}


public static class TargetDto {
private String to;
private Map<String, String> changeWord;
private String name;
}

public static class FileDto {
private String name;
private long size;
private String data;

}

@Getter
@AllArgsConstructor
public static class kkaoMessage {
private String account;
private String messageType;
private String senderProfile;
private String templateCode;
private String content;
private Long targetCount;
private List<String> targets;
private String senderNumber;
}

}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

코드 리뷰 결과, 몇 가지 수정 및 개선 사항을 제안드립니다.

  1. 클래스 이름의 일관성:

    • kkaoMessage 클래스는 Java의 클래스 네이밍 규칙에 따라 대문자로 시작해야 합니다. KakaoMessage와 같이 수정하는 것이 좋습니다.

  2. 중복 코드:

    • CommonMessage와 KakaoMessage에서 사용되는 일부 필드(예: messageType, content, targetCount)가 중복되어 있습니다. 이러한 공통 필드를 가진 부모 클래스를 만들어 상속받도록 하면 중복을 줄일 수 있습니다.

  3. Access Modifiers:

    • 모든 DTO 클래스에서 기본 생성자와 getter 외의 접근 제한자를 명시하지 않았습니다. 불필요한 인스턴스 생성을 방지하기 위해 이러한 클래스를 private 또는 protected로 만들고 필요한 경우 factory method를 사용하십시오.

  4. 타입 일관성:

    • targetCount 필드의 타입이 int에서 Long으로 바뀌어야 할 필요성이 있습니다. 이는 나중에 큰 숫자를 처리할 때 유용할 것입니다. KakaoMessage와 CommonMessage에서 일관성을 유지하세요.

  5. 오류 처리:

    • 각 DTO 필드에 대해 중요한 필수 항목이 있다면, 생성자에서 에러 처리를 추가하거나 유효성 검사를 수행하여 잘못된 데이터가 입력되지 않도록 할 수 있습니다.

  6. 명확한 주석 추가:

    • 각 DTO 클래스와 주요 필드에 대한 설명을 주석으로 추가하면 코드 읽기가 더 수월해질 것입니다.

  7. Lombok 사용 확인:

    • Lombok의 @Getter 관련 어노테이션은 필드가 private이면 정상작동하지만, 전체적인 사용 방식이 바람직한지 검토하고 필요 시 @Data 같은 다른 어노테이션을 사용해 getter/getter와 같은 오류 가능성을 줄일 수도 있습니다.

리팩토링을 통해 코드의 가독성을 높이고 유지보수를 쉽게 하기를 권장합니다.

4 changes: 4 additions & 0 deletions src/main/java/com/pictalk/message/dto/MessageResponseDto.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
package com.pictalk.message.dto;

public class MessageResponseDto {
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

코드에서 다음과 같은 부분들을 개선할 수 있습니다:

  1. 패키지 구조: com.pictalk.message.dto 패키지가 의미가 있지만, DTO 클래스에 필요한 필드와 메소드를 추가하는 것이 좋습니다.

  2. 필드 추가: MessageResponseDto 클래스는 현재 비어있습니다. 보통 DTO에는 데이터 전송에 필요한 속성들이 포함되어야 합니다. 예를 들어, 메시지 ID, 내용, 발신자 ID 등을 필드로 추가할 수 있습니다.

  3. 생성자 및 Getter/Setter 방법 추가: 필드가 추가된다면, 생성자(constructor), getter 및 setter 메소드를 자동으로 생성하는 것도 좋은 습관입니다. Lombok 라이브러리를 사용할 수도 있습니다.

  4. 클래스 주석 추가: 코드의 가독성을 높이기 위해 클래스를 설명하는 주석을 추가하는 것도 좋습니다.

  5. Equals 및 HashCode 메소드 오버라이드: 비교 연산이 필요할 경우, Equals 및 HashCode 메소드를 오버라이드 하는 것이 좋습니다.

예시:

package com.pictalk.message.dto;

public class MessageResponseDto {
    private Long messageId;
    private String content;
    private Long senderId;

    // 생성자
    public MessageResponseDto(Long messageId, String content, Long senderId) {
        this.messageId = messageId;
        this.content = content;
        this.senderId = senderId;
    }

    // Getter 및 Setter
    public Long getMessageId() {
        return messageId;
    }

    public void setMessageId(Long messageId) {
        this.messageId = messageId;
    }

    public String getContent() {
        return content;
    }

    public void setContent(String content) {
        this.content = content;
    }

    public Long getSenderId() {
        return senderId;
    }

    public void setSenderId(Long senderId) {
        this.senderId = senderId;
    }
    
    // toString(), equals(), hashCode() 추가 가능
}

이렇게 하면 이 클래스의 활용도가 높아지고 유지보수하기 쉬운 코드가 됩니다.

Loading
Loading