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.

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

[REFACTOR] 함수 파라미터 및 변하지 않아야 하는 변수에 final 키워드 적용 #143

Merged
merged 8 commits into from
Jan 21, 2024
Merged
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@ public abstract class AuthService {
private final MemberRepository memberRepository;

@Transactional
public abstract MemberSignUpVO saveMemberOrLogin(String platformType, MemberRequestDTO request);
public abstract MemberSignUpVO saveMemberOrLogin(final String platformType, final MemberRequestDTO request);

protected Member getMember(PlatformType platformType, String email) {
protected Member getMember(final PlatformType platformType, final String email) {
return memberRepository.findByPlatformTypeAndEmail(platformType, email)
.orElse(null);
}

protected Member saveUser(MemberRequestDTO request, String email, String name, String birthday, String gender,
String phoneNumber) {
protected Member saveUser(final MemberRequestDTO request, final String email, final String name, final String birthday, final String gender,
final String phoneNumber) {
Member newMember = createSocialMember(email, name, PlatformType.of(request.platformType()), birthday, gender, phoneNumber);
return memberRepository.saveAndFlush(newMember);
}

private static Member createSocialMember(String email, String name, PlatformType platformType, String birthYear,
String gender, String phoneNumber) {
private static Member createSocialMember(final String email, final String name, final PlatformType platformType, final String birthYear,
final String gender, final String phoneNumber) {
return Member.builder().email(email).name(name).platformType(platformType).role(Role.USER)
.birthYear(birthYear)
.gender(gender).phoneNumber(phoneNumber).build();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ void init() {
authServiceMap.put(PlatformType.NAVER, naverAuthService);
}

public AuthService getAuthService(PlatformType platformType) {
public AuthService getAuthService(final PlatformType platformType) {
return authServiceMap.get(platformType);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ public class MyController implements MemberApi{

@Override
@GetMapping("/name")
public ResponseEntity<SuccessResponse<NameResponseDTO>> getName(@AuthUser Member member) {
public ResponseEntity<SuccessResponse<NameResponseDTO>> getName(@AuthUser final Member member) {
return ResponseEntity.ok()
.body(SuccessResponse.of(MemberSuccessType.GET_MEMBER_NAME_SUCCESS,
memberService.getNickname(member)));
}

@Override
@GetMapping("/ticket")
public ResponseEntity<SuccessResponse<TicketResponseDTO>> getTicket(@AuthUser Member member) {
public ResponseEntity<SuccessResponse<TicketResponseDTO>> getTicket(@AuthUser final Member member) {
return ResponseEntity.ok()
.body(SuccessResponse.of(MemberSuccessType.GET_MEMBER_TICKET_SUCCESS,
memberService.getTicket(member)));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

@Schema(name = "NameResponseDTO", description = "멤버 이름 응답 DTO")
public record NameResponseDTO(@Schema(description = "멤버 이름", example = "류가은") String memberName) {
public static NameResponseDTO of(String memberName) {
public static NameResponseDTO of(final String memberName) {
return new NameResponseDTO(memberName);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
@Schema(name = "TicketResponseDTO", description = "멤버 첨삭권 응답 DTO")
public record TicketResponseDTO(@Schema(description = "멤버 이름", example = "류가은") String memberName,
@Schema(description = "사용자 첨삭권 개수", example = "5") int ticketCount) {
public static TicketResponseDTO of(String memberName, int ticketCount) {
public static TicketResponseDTO of(final String memberName, final int ticketCount) {
return new TicketResponseDTO(memberName, ticketCount);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ public class Member {
private LocalDateTime ticketPreviousPublicationTime;

@Builder
public Member(String email, String name, PlatformType platformType, Role role, String birthYear,
String gender, String phoneNumber) {
public Member(final String email, final String name, final PlatformType platformType, final Role role, final String birthYear,
final String gender, final String phoneNumber) {
this.email = email;
this.name = name;
this.platformType = platformType;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
public class MemberService {
private final MemberRepository memberRepository;

public NameResponseDTO getNickname(Member member) {
public NameResponseDTO getNickname(final Member member) {
return NameResponseDTO.of(member.getName());
}

public TicketResponseDTO getTicket(Member member) {
public TicketResponseDTO getTicket(final Member member) {
return TicketResponseDTO.of(member.getName(), member.getTicketCount());
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public ResponseEntity<SuccessResponse<List<SelectUniversityResponseDTO>>> getSel
@Override
@GetMapping("/exam")
public ResponseEntity<SuccessResponse<List<SelectUniversityExamsResponseDTO>>> getSelectUniversityExams(
@AuthUser Member member) {
@AuthUser final Member member) {
return ResponseEntity.ok().body(SuccessResponse.of(GET_SELECT_UNIVERSITY_EXAMS_SUCCESS,
selectUniversityService.getSelectUniversityExams(member)));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ public record SelectUniversityExamResponseDTO(@Schema(description = "시험 id",
@Schema(description = "시험 이름", example = "경영경제1") String examName,
@Schema(description = "시험 제한 시간(초)", example = "3600") int examTimeLimit,
@Schema(description = "시험 응시 상태", example = "시험 응시 전") String examStatus) {
public static SelectUniversityExamResponseDTO of(Long examId, String examName, int examTimeLimit,
String examStatus) {
public static SelectUniversityExamResponseDTO of(final Long examId, final String examName, final int examTimeLimit,
final String examStatus) {
return new SelectUniversityExamResponseDTO(examId, examName, examTimeLimit, examStatus);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ public record SelectUniversityExamsResponseDTO(@Schema(description = "대학 id"
@Schema(description = "대학 이름", example = "중앙대학교") String universityName,
@Schema(description = "단과대학 이름", example = "경영경제") String universityCollege,
@Schema(description = "시험 리스트") List<SelectUniversityExamResponseDTO> examList) {
public static SelectUniversityExamsResponseDTO of(Long universityId, String universityName,
String universityCollege,
List<SelectUniversityExamResponseDTO> examList) {
public static SelectUniversityExamsResponseDTO of(final Long universityId, final String universityName,
final String universityCollege,
final List<SelectUniversityExamResponseDTO> examList) {
return new SelectUniversityExamsResponseDTO(universityId, universityName, universityCollege, examList);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ public record SelectUniversityResponseDTO(
@Schema(description = "단과대학 이름", example = "경영경제") String collegeName,
@Schema(description = "대학 선택 여부", example = "true") boolean memberStatus
) {
public static SelectUniversityResponseDTO of(Long universityId, String universityName, String collegeName, boolean memberStatus) {
public static SelectUniversityResponseDTO of(final Long universityId, final String universityName, final String collegeName, final boolean memberStatus) {
return new SelectUniversityResponseDTO(universityId, universityName, collegeName, memberStatus);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
public record SelectUniversityUpdateResponseDTO(
@Schema(description="선택 완료 여부", example="true") boolean isSelected
) {
public static SelectUniversityUpdateResponseDTO of(boolean isSelected) {
public static SelectUniversityUpdateResponseDTO of(final boolean isSelected) {
return new SelectUniversityUpdateResponseDTO(isSelected);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public class SelectUniversity {
private University university;

@Builder
public SelectUniversity(Member member, University university) {
public SelectUniversity(final Member member, final University university) {
this.member = member;
this.university = university;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ public List<SelectUniversityResponseDTO> getSelectUniversities(Member member) {
return selectUniversityResponseDTOS;
}

public List<SelectUniversityExamsResponseDTO> getSelectUniversityExams(Member member) {
public List<SelectUniversityExamsResponseDTO> getSelectUniversityExams(final Member member) {
List<SelectUniversityExamsResponseDTO> selectUniversityExamsResponseDTOS = new ArrayList<>();
List<SelectUniversity> selectUniversities = selectUniversityRepository.findAllByMemberOrderByUniversityNameASCUniversityCollegeAsc(
final List<SelectUniversity> selectUniversities = selectUniversityRepository.findAllByMemberOrderByUniversityNameASCUniversityCollegeAsc(
member);

for (SelectUniversity selectUniversity : selectUniversities) {
Expand All @@ -66,22 +66,21 @@ public List<SelectUniversityExamsResponseDTO> getSelectUniversityExams(Member me
return selectUniversityExamsResponseDTOS;
}

private SelectUniversityExamsResponseDTO getSelectUniversityExamsResponseDTO(SelectUniversity selectUniversity,
Member member) {
List<SelectUniversityExamResponseDTO> selectUniversityExamResponseDTOS;
private SelectUniversityExamsResponseDTO getSelectUniversityExamsResponseDTO(final SelectUniversity selectUniversity,
final Member member) {

List<UniversityExam> universityExams = universityExamRepository.findAllByUniversityOrderByUniversityExamYearDesc(
final List<UniversityExam> universityExams = universityExamRepository.findAllByUniversityOrderByUniversityExamYearDesc(
selectUniversity.getUniversity());

selectUniversityExamResponseDTOS = getSelectUniversityExamResponseDTOS(universityExams, member);
final List<SelectUniversityExamResponseDTO> selectUniversityExamResponseDTOS = getSelectUniversityExamResponseDTOS(universityExams, member);

return SelectUniversityExamsResponseDTO.of(selectUniversity.getUniversity().getUniversityId(),
selectUniversity.getUniversity().getUniversityName(),
selectUniversity.getUniversity().getUniversityCollege(), selectUniversityExamResponseDTOS);
}

private List<SelectUniversityExamResponseDTO> getSelectUniversityExamResponseDTOS(
List<UniversityExam> universityExams, Member member) {
final List<UniversityExam> universityExams, final Member member) {
UniversityExamRecord universityExamRecord;
List<SelectUniversityExamResponseDTO> selectUniversityExamResponseDTOS = new ArrayList<>();
for (UniversityExam universityExam : universityExams) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ public class UniversityExamController implements UniversityApi{
@Override
@GetMapping("/{id}/info")
public ResponseEntity<SuccessResponse<UniversityExamInfoResponseDTO>> getUniversityExam(
@PathVariable("id") Long universityExamId) {
@PathVariable("id") final Long universityExamId) {
return ResponseEntity.ok().body(SuccessResponse.of(UniversityExamSuccessType.GET_UNIVERSITY_EXAM_SUCCESS,
universityExamService.getUniversityExam(universityExamId)));
}

@Override
@GetMapping("{id}/image")
public ResponseEntity<SuccessResponse<Page<UniversityExamImageResponseDTO>>> getUniversityExamImages(
@PathVariable("id") Long id, @RequestParam(defaultValue = "0") int page, Pageable pageable) {
@PathVariable("id") final Long id, @RequestParam(defaultValue = "0") final int page, final Pageable pageable) {
PageRequest pageRequest = PageRequest.of(page, 1);
Page<UniversityExamImageResponseDTO> images = universityExamService.getUniversityExamImages(id, pageRequest);
return ResponseEntity.ok()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ public record UniversityExamImageAndAnswerResponseDTO(
@Schema(description = "시험 문제 이미지 리스트") List<UniversityExamImageResponseDTO> examQuestionList,
@Schema(description = "이미지 해제 PDF URL") String examAnswerUrl
) {
static public UniversityExamImageAndAnswerResponseDTO of(String universityExamName,
List<UniversityExamImageResponseDTO> examQuestionList,
String examAnswerUrl) {
static public UniversityExamImageAndAnswerResponseDTO of(final String universityExamName,
final List<UniversityExamImageResponseDTO> examQuestionList,
final String examAnswerUrl) {
return new UniversityExamImageAndAnswerResponseDTO(universityExamName, examQuestionList, examAnswerUrl);
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

@Schema(name = "UniversityExamImageResponseDTO", description = "대학 시험 이미지 조회 요청 DTO")
public record UniversityExamImageResponseDTO(@Schema(description = "시험 문제 이미지 URL") String examImgUrl) {
static public UniversityExamImageResponseDTO of(String examImgUrl) {
public static UniversityExamImageResponseDTO of(final String examImgUrl) {
return new UniversityExamImageResponseDTO(examImgUrl);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
public record UniversityExamInfoResponseDTO(@Schema(description = "시험 id", example = "1") Long examId,
@Schema(description = "시험 이름(대학 + 시험 년도 + 시험 이름)", example = "건국대학교 - 2021 인문사회 1") String examName,
@Schema(description = "시험 제한 시간 (초)", example = "6000") int examTimeLimit) {
public static UniversityExamInfoResponseDTO of(Long examId, String examName, int examTimeLimit) {
public static UniversityExamInfoResponseDTO of(final Long examId, final String examName, final int examTimeLimit) {
return new UniversityExamInfoResponseDTO(examId, examName, examTimeLimit);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public class UniversityExamService {
private final CloudFrontService cloudFrontService;


public UniversityExamInfoResponseDTO getUniversityExam(Long universityExamId) {
public UniversityExamInfoResponseDTO getUniversityExam(final Long universityExamId) {
UniversityExam universityExam = universityExamRepository.findByUniversityExamId(universityExamId)
.orElseThrow(() -> new UniversityExamException(
UniversityExamExceptionType.INVALID_UNIVERSITY_EXAM));
Expand All @@ -40,7 +40,7 @@ public UniversityExamInfoResponseDTO getUniversityExam(Long universityExamId) {
universityExam.getUniversityExamTimeLimit());
}

public Page<UniversityExamImageResponseDTO> getUniversityExamImages(Long id, Pageable pageable) {
public Page<UniversityExamImageResponseDTO> getUniversityExamImages(final Long id, final Pageable pageable) {
UniversityExam universityExam = universityExamRepository.findByUniversityExamId(id)
.orElseThrow(() -> new UniversityExamException(
UniversityExamExceptionType.INVALID_UNIVERSITY_EXAM));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ public ResponseEntity<SuccessResponse<UniversityExamSheetPreSignedUrlResponseDTO
@Override
@PostMapping("/sheet")
public ResponseEntity<SuccessResponse<UniversityExamRecordIdResponse>> createUniversityExamRecord(
@Valid @RequestBody CreateUniversityExamRequestDTO createUniversityExamRequestDTO,
@AuthUser Member member) {
@Valid @RequestBody final CreateUniversityExamRequestDTO createUniversityExamRequestDTO,
@AuthUser final Member member) {
return ResponseEntity.status(HttpStatus.CREATED).body(SuccessResponse.of(
UniversityExamRecordSuccessType.CREATE_UNIVERSITY_EXAM_RECORD_SUCCESS,
universityExamRecordService.createUniversityExamRecord(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
@Schema(name = "UniversityExamRecordIdResponse", description = "대학 시험 기록 생성 응답 DTO")
public record UniversityExamRecordIdResponse(
@Schema(description = "기록된 대학 시험 답안 id", example = "1") Long universityExamRecordId) {
public static UniversityExamRecordIdResponse of(Long universityExamRecordId) {
public static UniversityExamRecordIdResponse of(final Long universityExamRecordId) {
return new UniversityExamRecordIdResponse(universityExamRecordId);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ public record UniversityExamRecordResponseDTO(
@Schema(description = "시험 해제 PDF URL", example = "1") String examAnswerUrl,
@Schema(description = "시험 첨삭 결과 PDF URL", example = "1") String examResultUrl
) {
public static UniversityExamRecordResponseDTO of(String universityExamName, String examAnswerUrl, String examResultUrl) {
public static UniversityExamRecordResponseDTO of(final String universityExamName, final String examAnswerUrl, final String examResultUrl) {
return new UniversityExamRecordResponseDTO(universityExamName, examAnswerUrl, examResultUrl);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
public record UniversityExamRecordResultResponseDTO(
@Schema(description = "첨삭 결과 PDF URL") String examResultUrl
) {
public static UniversityExamRecordResultResponseDTO of(String examResultUrl) {
public static UniversityExamRecordResultResponseDTO of(final String examResultUrl) {
return new UniversityExamRecordResultResponseDTO(examResultUrl);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
public record UniversityExamSheetPreSignedUrlResponseDTO(
@Schema(description = "시험보기: [3] 답안지 업로드 후 시험 기록 API 에서 다시 서버로 보내야하는 파일 이름") String resultFileName,
@Schema(description = "시험보기: [2] 답안지 업로드 API를 요청할 URL") String preSignedUrl) {
public static UniversityExamSheetPreSignedUrlResponseDTO of(String resultFileName, String preSignedUrl) {
public static UniversityExamSheetPreSignedUrlResponseDTO of(final String resultFileName, final String preSignedUrl) {
return new UniversityExamSheetPreSignedUrlResponseDTO(resultFileName, preSignedUrl);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ public class UniversityExamRecord {
private String examRecordResultFileName; // 첨삭

@Builder
public UniversityExamRecord(UniversityExam universityExam, Member member, ExamResultStatus examResultStatus,
int timeTakeExam, String examRecordSheetFileName) {
public UniversityExamRecord(final UniversityExam universityExam, final Member member, final ExamResultStatus examResultStatus,
final int timeTakeExam, final String examRecordSheetFileName) {
this.universityExam = universityExam;
this.member = member;
this.examResultStatus = examResultStatus;
Expand Down
Loading
Loading