[Spring] CRUD - Controller 공부

# 은행 시스템 API 가이드
## 학습 방법
1. **주석**
   - 작성한 모든 코드에 주석으로 설명을 추가
 
## 테스트 체크리스트
- ### 고객 관리 API
  - [ ] 등록
  - [ ] 조회
  - [ ] 수정
  - [ ] 삭제
 
- ### 계좌 관리 API
  - [ ] 생성
  - [ ] 조회
  - [ ] 잔액 조회
  - [ ] 삭제
 
- ### 거래 내역 API
  - [ ] 조회
  - [ ] 생성
  - [ ] 특정 거래 조회

---

Controller와 DTD만 사용해서 만드는 CRUD이다.

Controller에 사용하는 Annotation과 같은 것들을 자세히 공부할 수 있는 기회인 것 같아서, 이때동안 구현했던 코드를 보지않고 혼자 공부하며 작성을 했다.

방법은 하나하나 주석달아 분석하기

---

1. 고객관리 CRUD

1.1 고객 등록

/** @Controller와 @ResponseBody를 결합한 애너테이션, 각 메서드가 JSON 형태의 데이터를 클라이언트에 반환할 수 있도록 설정
 * 데이터를 반환하는 RESTful API 개발 시 사용
*/
@RestController
 
@RequestMapping(("/api/customers"))
// 클래스나 메서드에 공통된 URL 경로를 매핑하기 위해 사용,
// "/api/customers" 경로로 들어오는 요청을 이 컨트롤러에서 처리 하도록 설정
public class CustomerController {
 
    // 고객 등록
    @PostMapping
    /**
     * @PostMapping : HTTP Post Method에 해당하는 단축 표현으로, 주로 리소스를 서버에 생성하거나 저장할 때 사용
     * ResponseEntity : HTTP Response 상태 코드와 데이터를 함께 설정 및 반환 가능
     * @RequestBody : 요청의 JSON 데이터를 메서드의 매개변수로 변환하여 바인딩
     * CustomerRequestDto customerRequestDto : 요청 데이터를 담는 객체, 요청 데이터를 전달 받음
     * ResponseEntity<CustomerResponseDto> : 응답 본문에 CustomerResponseDto 객체를 담아 반환
     * */
    public ResponseEntity<CustomerResponseDto> createCustomers(@RequestBody CustomerRequestDto customerRequestDto){
        // 요청 처리 로직
        // Controller 테스트 단계 임으로 API 명세서 (API.md)에서 요구한 Response 데이터를 반환
        // id는 임시로 값 지정, 그 외의 요청 데이터는 response(응답) Dto에 직접적으로 값 넣어줌
        CustomerResponseDto customerResponseDto = new CustomerResponseDto(
                1L, // id
                customerRequestDto.getName(), // customerRequestDto에서 이름을 가져온다
                customerRequestDto.getEmail(), // customerRequestDto에서 이메일을 가져온다
                customerRequestDto.getPhone(), // customerRequestDto에서 폰번호를 가져온다
                customerRequestDto.getAddress() // customerRequestDto에서 주소를 가져온다
        );
        // ResponseEntity
        // 상태코드 CREATED(201)와 응답데이터(customerResponseDto)를 JSON형식으로 반환
        return ResponseEntity.status(HttpStatus.CREATED).body(customerResponseDto);
    }

 

1.2 고객 조회

// 고객 조회
    /**
     * @GetMapping("/{customerId}") : HTTP GET 메서드를 처리하며, "/{customerId}" 경로를 통해 특정 고객 ID를 조회할 수 있도록 매핑
     * @PathVariable : URL 경로의 변수 값을 메서드 매개변수로 바인딩
     * ResponseEntity<CustomerResponseDto> : 응답 본문에 CustomerResponseDto 객체를 담아 반환
     */
    @GetMapping("/{customerId}")
    public ResponseEntity<CustomerResponseDto> searchCustomers(@PathVariable Long customerId){
 
        // CustomerResponseDto 객체를 아래의 값들을 입력한 후 새로 생성한다
        CustomerResponseDto customerResponseDto = new CustomerResponseDto(
                customerId, // 고객 Id
                "Robbie", // 임시 이름
                "Robbie@example.com", // 임시 이메일
                "010-1234-5678", // 임시 전화번호
                "123 Seoul"// 임시 주소
        );
 
        // 상태코드 OK로 반환, 값을 입력한 customerResponseDto 객체를 JSON 형식으로 BODY에 출력
        return ResponseEntity.status(HttpStatus.OK).body(customerResponseDto);
    }

 

1.3 고객 수정

// 고객 정보 수정
    /**
     * HTTP Put Method에 해당, 서버에 리소스를 전체 수정할 때 사용
     * URL에 /{customerId} 를 입력하면, 특정 고객의 정보를 수정하도록 맵핑 되어있음
     * */
    @PutMapping("/{customerId}")
 
    /**
     * @PathVariable : URL 경로에 포함된 변수(customerId)를 메서드의 매개변수로 바인딩
     * ResponseEntity<CustomerResponseDto> : 수정된 고객 정보를 응답 본문으로 반환
     */
    public ResponseEntity<CustomerResponseDto> updateCustomers(@PathVariable Long customerId){
 
        // 수정 값을 응답 받을, 응답 데이터 객체 생성
        CustomerResponseDto customerResponseDto = new CustomerResponseDto(
                customerId,
                "하진이", // 수정할 이름
                "wlsdl7520@naver.com", // 수정할 이메일
                "010-1234-5678", // 수정할 전화번호
                "Daegu" // 수정할 주소
        );
        // 상태코드 OK(200)와 수정된 데이터(customerResponseDto) 객체를 JSON 형식으로 반환
        return ResponseEntity.status(HttpStatus.OK).body(customerResponseDto);
    }

 

1.4 고객 삭제

// 고객 삭제
    /**
     * HTTP DELETE 메서드로, 서버에서 리소스를 삭제할 때 사용
     * URL 경로에 "/{customerId}"를 포함하여 특정 고객을 삭제하도록 매핑
     * */
    @DeleteMapping("/{customerId}")
 
    /**
     * @PathVariable : URL 경로에 포함된 변수(customerId)를 메서드의 매개변수로 바인딩
     * ResponseEntity<String> : 응답 본문으로 String 형식으로 반환
     * */
    public ResponseEntity<String> deleteCustomers(@PathVariable Long customerId){
        // 상태코드 OK(200)과 삭제 성공 메세지("삭제 되었습니다")를 반ㅎ환
        return ResponseEntity.status(HttpStatus.OK).body("삭제 되었습니다");
    }

 

1.5 고객 DTO

// 객체의 캡슐화를 유지하면서, 클래스 외부에서 객체의 필드 값에 접근하거나 수정할 수 있도록 하기위해 사용
// @Getter 사용 시, get메서드 자동생성
@Getter
public class CustomerRequestDto {
 
    private String name; // 이름
 
    private String email; // 이메일
 
    private String phone; // 폰번호
 
    private String address; // 주소
 
    // 객체를 생성할 때 외부에서 받은 값을 필드에 넣는 역할을 한다.
    // 객체를 만들 때 필요한 값들을 한 번에 받아서, 올바르게 초기화하기 위해 사용됨
    public CustomerRequestDto(String name, String email, String phone, String address) {
        this.name = name;
        this.email = email;
        this.phone = phone;
        this.address = address;
    }
}

// 객체의 캡슐화를 유지하면서, 클래스 외부에서 객체의 필드 값에 접근하거나 수정할 수 있도록 하기위해 사용
// @Getter 사용 시, get메서드 자동생성
@Getter
public class CustomerResponseDto {
 
    @Id // 데이터베이스의 Primary Key임을 나타낸다
    /**
     * GenerationType : 자동 증가 방식을 설정하는 옵션
     * GenerationType.AUTO : 데이터베이스의 Auto Increment 기능을 사용, JPA가 데이터베이스에 맞는 방식을 자동으로 선택
     * */
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id; // id값
 
    private final String name; // 이름
 
    private final String email; // 이메일
 
    private final String phone; // 폰번호
 
    private final String address; // 주소
 
    // 객체를 생성할 때 외부에서 받은 값을 필드에 넣는 역할을 한다.
    // 객체를 만들 때 필요한 값들을 한 번에 받아서, 올바르게 초기화하기 위해 사용됨
    public CustomerResponseDto(Long id, String name, String email, String phone, String address) {
        this.id = id;
        this.name = name;
        this.email = email;
        this.phone = phone;
        this.address = address;
    }
}

 

---

2. 계좌관리 CRUD

2.1 계좌 생성

/** @Controller와 @ResponseBody를 결합한 애너테이션, 각 메서드가 JSON 형태의 데이터를 클라이언트에 반환할 수 있도록 설정
 * 데이터를 반환하는 RESTful API 개발 시 사용
 */
@RestController
 
@RequestMapping("/api/accounts")
// 클래스나 메서드에 공통된 URL 경로를 매핑하기 위해 사용,
// "/api/accounts" 경로로 들어오는 요청을 이 컨트롤러에서 처리 하도록 설정
public class AccountController {
 
    // 계좌 생성
    @PostMapping
    /**
     * @PostMapping : HTTP Post Method에 해당하는 단축 표현으로, 주로 리소스를 서버에 생성하거나 저장할 때 사용
     * ResponseEntity : HTTP Response 상태 코드와 데이터를 함께 설정 및 반환 가능
     * @RequestBody : 요청의 JSON 데이터를 메서드의 매개변수로 변환하여 바인딩
     * AccountResponseDto accountRequestDto : 요청 데이터를 담는 객체, 요청 데이터를 전달 받음
     * ResponseEntity<AccountResponseDto> : 응답 본문에 AccountResponseDto 객체를 담아 반환
     * */
    public ResponseEntity<AccountResponseDto> createAccount(@RequestBody AccountRequestDto accountRequestDto){
        // 요청 처리 로직
        // Controller 테스트 단계 임으로 API 명세서 (API.md)에서 요구한 Response 데이터를 반환
        // id는 임시로 값 지정, 그 외의 요청 데이터는 response(응답) Dto에 직접적으로 값 넣어줌
        AccountResponseDto accountResponseDto = new AccountResponseDto(
                101L,
                accountRequestDto.getCustomerId(),
                accountRequestDto.getAccountType(),
                accountRequestDto.getInitialDeposit()
        );
        // 상태코드 CREATED(201)와 응답데이터(customerResponseDto)를 JSON형식으로 반환
        return ResponseEntity.status(HttpStatus.CREATED).body(accountResponseDto);
    }

 

2.2 계좌 조회

// 계좌 조회
    /**
     * @GetMapping("/{accountId}") : HTTP GET 메서드를 처리하며, "/{accountId}" 경로를 통해 특정 고객 ID를 조회할 수 있도록 매핑
     * @PathVariable : URL 경로의 변수 값을 메서드 매개변수로 바인딩
     * ResponseEntity<AccountResponseDto> : 응답 본문에 AccountResponseDto 객체를 담아 반환
     */
    @GetMapping("/{accountId}")
    public ResponseEntity<AccountResponseDto> searchAccount(@PathVariable Long accountId){
 
        // AccountResponseDto 객체를 아래의 값들을 입력한 후 새로 생성한다
        AccountResponseDto accountResponseDto = new AccountResponseDto(
                accountId,
                1,
                "SAVINGS",
                1000.0
 
        );
 
        // 상태코드 OK로 반환, 값을 입력한 customerResponseDto 객체를 JSON 형식으로 BODY에 출력
        return ResponseEntity.status(HttpStatus.OK).body(accountResponseDto);
    }

 

2.3 계좌 잔액 조회

// 계좌 잔액 조회
    /**
     * @GetMapping("/{accountId}/balance") : HTTP GET 메서드를 처리하며, "/{accountId}/balance" 경로를 통해 특정 고객 ID를 조회할 수 있도록 매핑
     * @PathVariable : URL 경로의 변수 값을 메서드 매개변수로 바인딩
     * ResponseEntity<AccountBalaceResponseDto> : 응답 본문에 AccountBalaceResponseDto 객체를 담아 반환
     */
    @GetMapping("/{accountId}/balance")
    public ResponseEntity<AccountBalaceResponseDto> searchBalanceAccount(@PathVariable Long accountId){
 
        // CustomerResponseDto 객체를 아래의 값들을 입력한 후 새로 생성한다
        AccountBalaceResponseDto accountBalaceResponseDto = new AccountBalaceResponseDto(
                accountId,
                1000.0
        );
        // 상태코드 OK(200)와 수정된 데이터(customerResponseDto) 객체를 JSON 형식으로 반환
        return ResponseEntity.status(HttpStatus.OK).body(accountBalaceResponseDto);
    }

 

2.4 계좌 삭제

// 계좌 삭제
    /**
     * HTTP DELETE 메서드로, 서버에서 리소스를 삭제할 때 사용
     * URL 경로에 "/{accountId}"를 포함하여 특정 고객을 삭제하도록 매핑
     * */
    @DeleteMapping("/{accountId}")
 
    /**
     * @PathVariable : URL 경로에 포함된 변수(accountId)를 메서드의 매개변수로 바인딩
     * ResponseEntity<String> : 응답 본문으로 String 형식으로 반환
     * */
    public ResponseEntity<String> deleteAccount(@PathVariable Long accountId){
        // 상태코드 OK(200)과 삭제 성공 메세지("삭제 정상적으로 완료되었습니다")를 반환
        return ResponseEntity.status(HttpStatus.OK).body("삭제가 정상적으로 완료되었습니다.");
    }

 

2.5 계좌 DTO

// 객체의 캡슐화를 유지하면서, 클래스 외부에서 객체의 필드 값에 접근하거나 수정할 수 있도록 하기위해 사용
// @Getter 사용 시, get메서드 자동생성
@Getter
public class AccountRequestDto {
 
 
    private Integer customerId;
 
    private String accountType;
 
    private Double initialDeposit;
 
    // 객체를 생성할 때 외부에서 받은 값을 필드에 넣는 역할을 한다.
    // 객체를 만들 때 필요한 값들을 한 번에 받아서, 올바르게 초기화하기 위해 사용됨
    public AccountRequestDto(Integer customerId, String accountType, Double initialDeposit) {
        this.customerId = customerId;
        this.accountType = accountType;
        this.initialDeposit = initialDeposit;
    }
}

// 객체의 캡슐화를 유지하면서, 클래스 외부에서 객체의 필드 값에 접근하거나 수정할 수 있도록 하기위해 사용
// @Getter 사용 시, get메서드 자동생성
@Getter
public class AccountResponseDto {
 
    private Long accountId;
 
    private Integer customerId;
 
    private String accountType;
 
    private Double balance;
 
 
    // 객체를 생성할 때 외부에서 받은 값을 필드에 넣는 역할을 한다.
    // 객체를 만들 때 필요한 값들을 한 번에 받아서, 올바르게 초기화하기 위해 사용됨
    public AccountResponseDto(Long accountId, Integer customerId, String accountType, Double balance) {
        this.accountId = accountId;
        this.customerId = customerId;
        this.accountType = accountType;
        this.balance = balance;
    }
}

// 객체의 캡슐화를 유지하면서, 클래스 외부에서 객체의 필드 값에 접근하거나 수정할 수 있도록 하기위해 사용
// @Getter 사용 시, get메서드 자동생성
@Getter
public class AccountBalaceResponseDto {
 
    private Long accountId;
 
    private Double balance;
 
 
    // 객체를 생성할 때 외부에서 받은 값을 필드에 넣는 역할을 한다.
    // 객체를 만들 때 필요한 값들을 한 번에 받아서, 올바르게 초기화하기 위해 사용됨
    public AccountBalaceResponseDto(Long accountId, Double balance) {
        this.accountId = accountId;
        this.balance = balance;
    }
}

---

3. 거래 내역 CRUD

3.1 거래 조회

/** @Controller와 @ResponseBody를 결합한 애너테이션, 각 메서드가 JSON 형태의 데이터를 클라이언트에 반환할 수 있도록 설정
 * 데이터를 반환하는 RESTful API 개발 시 사용
 */
@RestController
@RequestMapping("/api/transactions")
// 클래스나 메서드에 공통된 URL 경로를 매핑하기 위해 사용,
// "/api/transactions" 경로로 들어오는 요청을 이 컨트롤러에서 처리 하도록 설정
public class TransactionController {
 
    // 거래 내역 조회
    // @GetMapping : HTTP GET 메서드를 처리하며, 일반적인 요청 전체를 조회
    @GetMapping
    // ResponseEntity : HTTP Response 상태 코드와 데이터를 함께 설정 및 반환 가능
    public ResponseEntity<List<TransactionResponseDto>> getTransaction(@ModelAttribute TransactionRequestDto requestDto){
        // 요청 데이터를 바탕으로 거래 내역(List<TransactionResponseDto>)을 응답으로 반환
 
        // @ModelAttribute : HTTP 요청의 파라미터를 TransactionRequestDto 객체에 자동으로 매핑
        // - 요청 URL의 쿼리 파라미터를 기반으로 TransactionRequestDto 객체가 생성
        // - 예) 요청 URL: /transactions?customerId=101&transactionType=DEPOSIT
        //      -> requestDto.customerId = 101
        //      -> requestDto.transactionType = "DEPOSIT"
 
        // 여러개의 거래들을 저장하기 위해 List 사용해서, 객체 생성
        List<TransactionResponseDto> transaction = new ArrayList<>();
 
        // 응답 데이터를 TransactionResponseDto 객체에 담아 새로 생성 후 transaction 리스트에 추가
        transaction.add(new TransactionResponseDto(1001L,101,"DEPOSIT",500.0,"2024-01-15T10:00:00"));
        transaction.add(new TransactionResponseDto(1002L,101,"WITHDRAWAL",200.0,"2024-01-20T14:30:00"));
 
        // 새로운 응답코드 OK(200)을 반환
        return new ResponseEntity<>(transaction,HttpStatus.OK);
    }

 

3.2 거래 생성

// 거래 생성
    @PostMapping
    /**
     * @PostMapping : HTTP Post Method에 해당하는 단축 표현으로, 주로 리소스를 서버에 생성하거나 저장할 때 사용
     * ResponseEntity : HTTP Response 상태 코드와 데이터를 함께 설정 및 반환 가능
     * @RequestBody : 요청의 JSON 데이터를 메서드의 매개변수로 변환하여 바인딩
     * TransactionResponseDto transactionResponseDto : 요청 데이터를 담는 객체, 요청 데이터를 전달 받음
     * ResponseEntity<TransactionResponseDto> : 응답 본문에 transactionResponseDto 객체를 담아 반환
     * */
    public ResponseEntity<TransactionResponseDto> createTransaction(@RequestBody TransactionRequestDto requestDto){
        // 요청 처리 로직
        // 현재 단계는 Controller 테스트를 위한 단계이므로, API 명세서(API.md)에 정의된 형식으로 응답 데이터를 반환
        // id는 실제 데이터베이스 연동이 없으므로 임시로 데이터를 지정하고,
        // 나머지 필드는 요청(Request) DTO에서 전달받은 데이터를 사용
        TransactionResponseDto transactionResponseDto = new TransactionResponseDto(
                // 임시로 값을 넣어줌
                1003L,
                101,
                "DEPOSIT",
                1000.0,
                "2024-02-01T11:00:00"
        );
        // 상태코드 OK(200)와 응답데이터(TransactionResponseDto)를 JSON형식으로 반환
        return ResponseEntity.status(HttpStatus.OK).body(transactionResponseDto);
    }

 

3.3 특정 거래 조회

// 특정 거래 조회
    /**
     * @GetMapping("/{transactionId}") : HTTP GET 메서드를 처리하며, "/{transactionId}" 경로를 통해 특정 고객 ID를 조회할 수 있도록 매핑
     * @PathVariable : URL 경로의 변수 값을 메서드 매개변수로 바인딩
     * ResponseEntity<TransactionResponseDto> : 응답 본문에 TransactionResponseDto 객체를 담아 반환
     */
    @GetMapping("/{transactionId}")
    public ResponseEntity<TransactionResponseDto> findTransaction(@PathVariable Long transactionId){
        // 요청 처리 로직
        // 현재 단계는 Controller 테스트를 위한 단계이므로, API 명세서(API.md)에 정의된 형식으로 응답 데이터를 반환
        // id는 실제 데이터베이스 연동이 없으므로 임시로 데이터를 지정하고,
        // 나머지 필드는 요청(Request) DTO에서 전달받은 데이터를 사용
        TransactionResponseDto transactionResponseDto = new TransactionResponseDto(
                transactionId,
                101,
                "DEPOSIT",
                500.0,
                "2024-01-15T10:00:00"
        );
        // 상태코드 OK(200)와 응답데이터(TransactionResponseDto)를 JSON형식으로 반환
        return ResponseEntity.status(HttpStatus.OK).body(transactionResponseDto);
    }

 

3.4 거래 DTO

// 객체의 캡슐화를 유지하면서, 클래스 외부에서 객체의 필드 값에 접근하거나 수정할 수 있도록 하기위해 사용
// @Getter 사용 시, get메서드 자동생성
@Getter
public class TransactionRequestDto {
 
    private Integer customerId;
 
    private String startDate;
 
    private String endDate;
 
    // 객체를 생성할 때 외부에서 받은 값을 필드에 넣는 역할을 한다.
    // 객체를 만들 때 필요한 값들을 한 번에 받아서, 올바르게 초기화하기 위해 사용됨
    public TransactionRequestDto(Integer customerId, String startDate, String endDate) {
        this.customerId = customerId;
        this.startDate = startDate;
        this.endDate = endDate;
    }
}

// 객체의 캡슐화를 유지하면서, 클래스 외부에서 객체의 필드 값에 접근하거나 수정할 수 있도록 하기위해 사용
// @Getter 사용 시, get메서드 자동생성
@Getter
public class TransactionResponseDto {
 
    private Long transactionId;
 
    private Integer accountId;
 
    private String transactionType;
 
    private Double amount;
 
    private String transactionDate;
 
    // 객체를 생성할 때 외부에서 받은 값을 필드에 넣는 역할을 한다.
    // 객체를 만들 때 필요한 값들을 한 번에 받아서, 올바르게 초기화하기 위해 사용됨
    public TransactionResponseDto(Long transactionId, Integer accountId,
                                  String transactionType, Double amount, String transactionDate) {
        this.transactionId = transactionId;
        this.accountId = accountId;
        this.transactionType = transactionType;
        this.amount = amount;
        this.transactionDate = transactionDate;
    }
}

---