[SpringBoot] CRUDproject_MallangMEMO

📍 GitHub 바로가기

1 Service Architecture

---

2 Project API

기능	Method	URL	Return
메인페이지	GET	/	index.html
메모 생성	POST	/api/memos	Memo
메모 조회	GET	/api/memos	List<Memo>
메모 변경	PUT	/api/memos/{id}	Long
메모 삭제	DELETE	/api/memos/{id}	Long

---

3 Project setting

• Spring Boot DevTools : 코드수정 → 어플리케이션을 재실행해야 되는 불편한 점을 해결할 수 있도록 제공되는 모듈

---

4 Entity 설계

1️⃣ Timestamped

📍 main > entity > Timestamped.java

@Getter
@MappedSuperclass // 조상클래스
// @EntityListeners -> Application에 @EnableJpaAuditing 추가필수
@EntityListeners(AuditingEntityListener.class)
public class Timestamped {
    // 생성시간
    @CreatedDate
    private LocalDateTime createdAt;

    // 수정시간
    @LastModifiedDate
    private LocalDateTime modifiedAt;
}

2️⃣ Memo

📍 main > entity > Memo.java

@Getter
@Entity
@NoArgsConstructor // 기본생성자를 자동으로 추가
public class Memo extends Timestamped {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;

    @Column(nullable = false)
    private String username;

    @Column(nullable = false)
    private String contents;
}

---

5 Repository 설계

📍 main > repository > MemoRepository.java

public interface MemoRepository extends JpaRepository<Memo, Long> {
}

---

6 RequestDto 설계

📍 main > dto > MemoRequestDto

@Getter
public class MemoRequestDto {
    private String username;
    private String contents;
}

---

7 Memo생성 설계

1️⃣ Controller

📍 main > controller > MemoController.java

@RestController // @Controller + @ResponseBody -> Json형태의 데이터반환
@RequiredArgsConstructor // final, @Notnull -> 생성자 자동생성
public class MemoController {
    // service단 객체 불러옴
    private final MemoService memoService;

    // 메인페이지 - html 반환
    @GetMapping("/")
    public ModelAndView home() {
        return new ModelAndView("index");
    }

    // Memo 생성하기
    @PostMapping("/api/memos")
    public Memo createMemo(@RequestBody MemoRequestDto memoRequestDto) {
        return memoService.createMemo(memoRequestDto);
    }
}

2️⃣ Service

📍 main > service > MemoService.java

@Service
@RequiredArgsConstructor // final, @Notnull -> 생성자 자동생성
public class MemoService {
    private final MemoRepository memoRepository;

    // DB 작업처리 중, 오류발생 -> 모든 작업 원상태로 돌림
    @Transactional
    public Memo createMemo(MemoRequestDto memoRequestDto) {
        // Memo : 반환타입(Memo 클래스의 객체반환)
        Memo memo = new Memo(memoRequestDto);
        memoRepository.save(memo);
        return memo;
    }
}

3️⃣ Entity 수정

📍 main > entity > Memo.java

• MemoRequestDto → Client 입력값 생성자로 덮어씌움

@Getter
@Entity
@NoArgsConstructor // 기본생성자를 자동으로 추가
public class Memo extends Timestamped {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;

    @Column(nullable = false)
    private String username;

    @Column(nullable = false)
    private String contents;

    // MemoRequestDto -> 값이 덮어씌워짐
    public Memo(MemoRequestDto memoRequestDto) {
        this.username = memoRequestDto.getUsername();
        this.contents = memoRequestDto.getContents();
    }
}

4️⃣ H2-console, Postman 확인

---

8 Memo조회 설계

1️⃣ Controller

@RestController // @Controller + @ResponseBody -> Json형태의 데이터반환
@RequiredArgsConstructor // final, @Notnull -> 생성자 자동생성
public class MemoController {

    // service단 객체 불러옴
    private final MemoService memoService;

    // 메인페이지 - html 반환
    @GetMapping("/")
    public ModelAndView home() {
        return new ModelAndView("index");
    }

    // Memo 생성하기
    @PostMapping("/api/memos")
    public Memo createMemo(@RequestBody MemoRequestDto memoRequestDto) {
        return memoService.createMemo(memoRequestDto);
    }

    // Memo 조회하기
    @GetMapping("/api/memos")
    public List<Memo> getMemos() {
        return memoService.getMemos();
    }
}

2️⃣ Service

@Service
@RequiredArgsConstructor // final, @Notnull -> 생성자 자동생성
public class MemoService {

    private final MemoRepository memoRepository;

    // Memo 생성하기
    // DB 작업처리 중, 오류발생 -> 모든 작업 원상태로 돌림
    @Transactional
    public Memo createMemo(MemoRequestDto memoRequestDto) {
        // Memo : 반환타입(Memo 클래스의 객체반환)
        Memo memo = new Memo(memoRequestDto);
        memoRepository.save(memo);
        return memo;
    }

    // Memo 조회하기
    @Transactional(readOnly = true)
    public List<Memo> getMemos() {
        // 생성시간기준 내림차순으로 데이터 가져옴
        // Repository랑 연결필수 (반환타입 + 조회조건)
        return memoRepository.findAllByOrderByModifiedAtDesc();
    }
}

3️⃣ Repository

public interface MemoRepository extends JpaRepository<Memo, Long> {
    // Memo 조회하기
    List<Memo> findAllByOrderByModifiedAtDesc();

    // 반환타입 + 조회조건
}

4️⃣ Postman 확인

---

9 Memo수정 설계

1️⃣ Controller

@RestController // @Controller + @ResponseBody -> Json형태의 데이터반환
@RequiredArgsConstructor // final, @Notnull -> 생성자 자동생성
public class MemoController {

    // service단 객체 불러옴
    private final MemoService memoService;

    // 메인페이지 - html 반환
    @GetMapping("/")
    public ModelAndView home() {
        return new ModelAndView("index");
    }

    // Memo 생성하기
    @PostMapping("/api/memos")
    public Memo createMemo(@RequestBody MemoRequestDto memoRequestDto) {
        return memoService.createMemo(memoRequestDto);
    }

    // Memo 조회하기
    @GetMapping("/api/memos")
    public List<Memo> getMemos() {
        return memoService.getMemos();
    }

    // Memo 수정하기
    @PutMapping("/api/memos/{id}")
    public Long updateMemo(@PathVariable Long id, // RESTful 통신방법
                           @RequestBody MemoRequestDto memoRequestDto) {
        return memoService.updateMemo(id, memoRequestDto);
    }
}

2️⃣ Service

@Service
@RequiredArgsConstructor // final, @Notnull -> 생성자 자동생성
public class MemoService {

    private final MemoRepository memoRepository;

    // Memo 생성하기
    // DB 작업처리 중, 오류발생 -> 모든 작업 원상태로 돌림
    @Transactional
    public Memo createMemo(MemoRequestDto memoRequestDto) {
        // Memo : 반환타입(Memo 클래스의 객체반환)
        Memo memo = new Memo(memoRequestDto);
        memoRepository.save(memo);
        return memo;
    }

    // Memo 조회하기
    @Transactional(readOnly = true)
    public List<Memo> getMemos() {
        // 생성시간기준 내림차순으로 데이터 가져옴
        // Repository랑 연결필수 (반환타입 + 조회조건)
        return memoRepository.findAllByOrderByModifiedAtDesc();
    }

    // Memo 수정하기
    @Transactional
    public Long updateMemo(Long id, MemoRequestDto memoRequestDto) {
        // 파라미터로 받아온 Id -> DB에 존재하는지 확인 & 객체에 담아옴
        // 파라미터로 받아온 Id -> DB에 존재하지 않으면 예외처리
        Memo memo = memoRepository.findById(id).orElseThrow(
                () -> new IllegalArgumentException("아이디가 존재하지 않습니다.")
        );

        // Dto값 -> 기존 객체(파라미터 id로 찾은)에 덮어씌우기
        memo.update(memoRequestDto);

        // Id값 반환
        return memo.getId();
    }
}

3️⃣ Entity

@Getter
@Entity
@NoArgsConstructor // 기본생성자를 자동으로 추가
public class Memo extends Timestamped {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;

    @Column(nullable = false)
    private String username;

    @Column(nullable = false)
    private String contents;

    // Memo 값 덮어씌우는 역할 (생성자)
    public Memo(MemoRequestDto memoRequestDto) {
        this.username = memoRequestDto.getUsername();
        this.contents = memoRequestDto.getContents();
    }

    // Memo 수정하기 (MemoService -> update)
    public void update(MemoRequestDto memoRequestDto) {
        this.username = memoRequestDto.getUsername();
        this.contents = memoRequestDto.getContents();
    }
}

4️⃣ Postman 확인

• 초기 전체 Memo
  

• Memo update
  

• Memo 재조회
  

---

10 Memo삭제 설계

1️⃣ Controller

@RestController // @Controller + @ResponseBody -> Json형태의 데이터반환
@RequiredArgsConstructor // final, @Notnull -> 생성자 자동생성
public class MemoController {

    // service단 객체 불러옴
    private final MemoService memoService;

    // 메인페이지 - html 반환
    @GetMapping("/")
    public ModelAndView home() {
        return new ModelAndView("index");
    }

    // Memo 생성하기
    @PostMapping("/api/memos")
    public Memo createMemo(@RequestBody MemoRequestDto memoRequestDto) {
        return memoService.createMemo(memoRequestDto);
    }

    // Memo 조회하기
    @GetMapping("/api/memos")
    public List<Memo> getMemos() {
        return memoService.getMemos();
    }

    // Memo 수정하기
    @PutMapping("/api/memos/{id}")
    public Long updateMemo(@PathVariable Long id, // RESTful 통신방법
                           @RequestBody MemoRequestDto memoRequestDto) {
        return memoService.updateMemo(id, memoRequestDto);
    }

    // Memo 삭제하기
    @DeleteMapping("/api/memos/{id}")
    public Long deleteMemo(@PathVariable Long id) {
        return memoService.deleteMemo(id);
    }
}

2️⃣ Service

@Service
@RequiredArgsConstructor // final, @Notnull -> 생성자 자동생성
public class MemoService {

    private final MemoRepository memoRepository;

    // Memo 생성하기
    // DB 작업처리 중, 오류발생 -> 모든 작업 원상태로 돌림
    @Transactional
    public Memo createMemo(MemoRequestDto memoRequestDto) {
        // Memo : 반환타입(Memo 클래스의 객체반환)
        Memo memo = new Memo(memoRequestDto);
        memoRepository.save(memo);
        return memo;
    }

    // Memo 조회하기
    @Transactional(readOnly = true)
    public List<Memo> getMemos() {
        // 생성시간기준 내림차순으로 데이터 가져옴
        // Repository랑 연결필수 (반환타입 + 조회조건)
        return memoRepository.findAllByOrderByModifiedAtDesc();
    }

    // Memo 수정하기
    @Transactional
    public Long updateMemo(Long id, MemoRequestDto memoRequestDto) {
        // 파라미터로 받아온 Id -> DB에 존재하는지 확인 & 객체에 담아옴
        // 파라미터로 받아온 Id -> DB에 존재하지 않으면 예외처리
        Memo memo = memoRepository.findById(id).orElseThrow(
                () -> new IllegalArgumentException("아이디가 존재하지 않습니다.")
        );

        // Dto값 -> 기존 객체(파라미터 id로 찾은)에 덮어씌우기
        memo.update(memoRequestDto);

        // Id값 반환
        return memo.getId();
    }

    // Memo 삭제하기
    @Transactional
    public Long deleteMemo(Long id) {
        // Id 존재여부 확인 -> 예외처리
        memoRepository.findById(id).orElseThrow(
                () -> new IllegalArgumentException("아이디가 존재하지 않습니다.")
        );

        // Memo 삭제
        memoRepository.deleteById(id);

        // Id값 반환
        return id;
    }
}

3️⃣ Postman 확인

• Memo 생성 후 조회
  

• Memo 삭제
  

• Memo 조회