스프링 백엔드 개발 해보기

김영한·2021년 1월 10일
JavaSpring
0

Spring

목록 보기
2/5

출처
Github
유용한 단축키

📢 백엔드 예제

  • 데이터 : 회원ID, 이름
  • 기능 : 회원 등록, 조회

📍 일반적인 웹 애플리케이션 계층구조

  • 컨트롤러 : 웹 MVC의 컨트롤러 역할
  • 서비스 : 핵심 비즈니스 로직 구현
  • 리포지토리 : 데이터 베이스에 접근, 도메인 객체를 DB에 저장하고 관리
  • 도메인 : 비즈니스 도메인 객체
    • 회원, 주문, 쿠폰 등 주로 데이터 베이스에 저장하고 관리

📍 클래스 의존관계

  • 아직 데이터 저장소가 선정x, 우선 인터페이스로 구현 클래스를 변경할 수 있도록 설계

📍 회원 도메인과 리포지토리 만들기


Member와 MemoryMemberRepository는 Java로 MemberRepository는 Interface로 만들자.

Member

public class Member {

    // Getter and Setter 만들기
    private Long id;
    private String name;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

MemberRepository

public interface MemberRepository {
    Member save(Member member);
    Optional<Member> findByID(Long id); // Optional : 값이 없으면 null로 처리하는 방법
    Optional<Member> findByName(String name);
    List<Member> findAll();
}

MemoryMemberRepository

public class MemoryMemberRepository implements MemberRepository{
    // 동시성 문제 고려 x
    private static Map<Long, Member> store = new HashMap<>();
    private static long sequence = 0L;

    @Override
    public Member save(Member member) {
        member.setId(++sequence);
        store.put(member.getId(), member);
        return member;
    }

    @Override
    public Optional<Member> findByID(Long id) {
        return Optional.ofNullable(store.get(id)); // Null이여도 사용 가능하게
    }

    @Override
    public Optional<Member> findByName(String name) {
        // 파라미터로 넘어온 name과 member에 있는 name이 같은 것을 필터링해서 반환
        return store.values().stream()
                .filter(member -> member.getName().equals(name))
                .findAny();
    }

    @Override
    public List<Member> findAll() {
        return new ArrayList<>(store.values());
    }
}

설명은 주석을 참고하자!

📢 테스트 코드 작성

자바의 main 메서드를 통해서 실행하면 오래 걸리고, 반복 실행하기 어렵다는 단점이 있어서 JUnit이라는 프레임워크로 테스트를 실행한다.

src/text/java 하위 폴더에 생성한다.

public class MemoryMemberRepositoryTest {

    MemoryMemberRepository repository = new MemoryMemberRepository();

    @Test // save 테스트
    public void save() {
        Member member = new Member();
        member.setName("spring"); // member를 저장하고

        repository.save(member); // repository에 넣는다.

        Member result = repository.findByID(member.getId()).get(); // Optional에서 get으로 값을 꺼낸다.
        Assertions.assertThat(member).isEqualTo(result); // member와 result가 같은지 확인(Go에서 사용한거와 같음)
    }
    
}


Run했을 때 성공하면 다음과 같은 결과가 나온다.

나머지 테스트 코드도 작성해보자.

...
    @Test // findByName 테스트
    public void findByName() {
        Member member1 = new Member();
        member1.setName("spring1");
        repository.save(member1);

        Member member2 = new Member();
        member2.setName("spring2");
        repository.save(member2);

        Member result = repository.findByName("spring1").get();

        Assertions.assertThat(result).isEqualTo(member1);
    }

    @Test // findAll 테스트
    public void findAll() {
        Member member1 = new Member();
        member1.setName("spring1");
        repository.save(member1);

        Member member2 = new Member();
        member2.setName("spring2");
        repository.save(member2);

        List<Member> result = repository.findAll();

        Assertions.assertThat(result.size()).isEqualTo(2);
    }

전체를 Run해보면 에러가 다음과 같은 에러가 뜬다.

그 이유는 테스트 코드는 서로 의존 관계없이(순서에 상관없이) 실행되므로 findAll 메소드에서 이미 repository에 저장이 되어버리고 findByName이 실행되므로 오류가 뜬다.
항상 테스트 코드를 설계할 때는 서로 순서와 관계없이 설계되어야한다.

⭐ 해결 방법으로는 테스트 하나가 끝나면 데이터를 clear 해주면 된다.

MemoryMemberRepository

...
    public void clearStore() { // test 코드에서 사용되는데 store에 저장되어있는 데이터를 비워준다.
        store.clear();
    }

새로 생성해주고

MemoryMemberRepositoryTest

...
    @AfterEach // 각 메소드가 실행이 끝날 때마다 동작을 하는 콜백 메소드
    public void afterEach() {
        repository.clearStore();
    }
...

AfterEach 메소드를 넣어주면 각 메소드가 끝날 때마다 store를 clear해준다.


다시 전체를 Run했을 때 오류없이 잘 실행된다.

📢 회원 서비스

회원가입 기능과 조회 기능을 만들어보자.

public class MemberService {

    private final MemberRepository memberRepository = new MemoryMemberRepository();

    /**
     * 회원 가입
     */
    public Long join(Member member) {
        // 같은 이름의 회원은 x
        validateDuplicateMember(member);

        memberRepository.save(member);
        return member.getId();
    }

    private void validateDuplicateMember(Member member) {
        memberRepository.findByName(member.getName())
                .ifPresent(m -> { // Optional이여서 사용하는 방법(if != null과 같은 의미)
                    throw new IllegalStateException("이미 존재하는 회원입니다.");
                });
    }

    /**
     * 전체 회원을 조회
     */
   public List<Member> findMembers() {
       return memberRepository.findAll();
   }

   public Optional<Member> findOne(Long memberId) {
       return memberRepository.findByID(memberId);
   }
}

📍 서비스 테스트

클래스 명에서 Alt + Enter를 누르고 Create test를 누르면 해당 클래스의 테스트 환경을 쉽게 만들 수 있다.

class MemberServiceTest {

    MemberService memberService;
    MemoryMemberRepository memberRepository;

    @BeforeEach // 각 메소드를 실행하기 전에 동작하는 메소드
    public void BeforeEach() {
        memberRepository = new MemoryMemberRepository();
        memberService = new MemberService(memberRepository); // 같은 memberRepository를 사용(Dependency Injection)
    }

    @AfterEach // 각 메소드가 실행이 끝날 때마다 동작을 하는 콜백 메소드
    public void afterEach() {
        memberRepository.clearStore();
    }

    @Test
    void 회원가입() {
        // 테스트 패턴
        // given
        Member member = new Member();
        member.setName("hello");

        // when
        Long saveId = memberService.join(member);

        // then
        Member findMember = memberService.findOne(saveId).get();
        Assertions.assertThat(member.getName()).isEqualTo(findMember.getName());
    }

    @Test
    public void 중복_회원_예외() {
        //given
        Member member1 = new Member();
        member1.setName("spring");

        Member member2 = new Member();
        member2.setName("spring");

        //when
        memberService.join(member1);
        // 예외 처리(member2를 또 join하면 오류가 뜸)
        IllegalStateException e = assertThrows(IllegalStateException.class, () -> memberService.join(member2));
        Assertions.assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");

        /*try {
            memberService.join(member2);
            fail();
        } catch (IllegalStateException e) {
            // 정상적으로 성공
            Assertions.assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
        }*/


        //then
    }

    @Test
    void findMembers() {
    }

    @Test
    void findOne() {
    }
}


결과가 잘 나오는 것을 볼 수 있다.

📢 Dependency Injection(DI)

참고 예시2, 참고 예시1

사용하는 이유

  1. Unit Test가 용이해진다.
  2. 코드의 재활용성을 높여준다.
  3. 객체 간의 의존성(종속성)을 줄이거나 없엘 수 있다.
  4. 객체 간의 결합도이 낮추면서 유연한 코드를 작성할 수 있다
  • 스프링 빈을 등록하는 2가지 방법
    1. 컴포넌트 스캔과 자동 의존관계 설정
    2. 자바 코드로 직접 스프링 빈 등록

📍 컴포턴트 스캔방법

@Controller, @Service, @Repository -> 정형화된 패턴

Controller를 통해서 외부 요청을 받고
Service에서 비지니스 로직을 만들고
Repository에서 데이터를 저장

이렇게 설정을 해주면 Spring이 쭉 가지고 온다.

@Autowired -> 연결(멤버 컨트롤러가 생성될 때 스프링 빈에 등록되어있는 멤버 서비스 객체를 가져와서 넣어준다. -> 의존관계 주입)

📍 자바 코드로 직접 스프링 빈 등록

@Service, @Repository, @Autowired 이노테이션을 지우고 진행

SpringConfig

@Configuration
public class SpringConfig {

    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository());
    }

    @Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }
}

@Configuration과 @Bean을 이용
그림처럼 memberService와 memberRepository를 스프링이 올라올 때 스프링 빈에 올리는 코드이다.
@Controller는 만들어줘야된다.

⭐ 각 방법의 참고

  • DI에는 필드 주입, Setter 주입, 생성자 주입 3가지 방법이 있는데 의존 관계가 실행 중에 동적으로 변하는 경우는 거의 없으므로 생성자 주입을 권장
  • 실무에서는 정형화된 패턴을 사용할 때 컴포넌트 스캔을 사용하고, 정형화되지 않거나 상황에 따라 구현 클래스를 변경해야하면 설정을 통해 스프링 빈으로 등록한다.

📢 웹 MVC 개발(회원 관리 예제)

📍 홈 화면 추가

HomeController

@Controller
public class HomeController {

    @GetMapping("/")
    public String home() {
        return "home";
    }
}


HTML 파일은 깃허브 참고

📍 등록

MemberController

@Controller
public class MemberController {
    ...

    @GetMapping("/members/new") // 회원 등록을 눌렀을 때(Get은 url 창에 치는거와 똑같음, 조회할 때 사용)
    public String createForm() {
        return "members/createMemberForm"; // 이 위치로 이동(templates에서 찾는다.)
    }

    @PostMapping("/members/new") // 회원 등록 페이지에서 등록을 눌렀을 때(Post는 데이터를 Form같은 곳에 넣어서 전달할 때 사용, 등록할 때 사용)
    public String create(MemberForm form) {
        Member member = new Member();
        member.setName(form.getName());

        memberService.join(member);

        return "redirect:/";
    }
}

MemberForm

public class MemberForm {
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

HTML 파일은 깃허브 참고

📍 조회

MemberController

@Controller
public class MemberController {
    ...

    @GetMapping("/members")
    public String list(Model model) {
        List<Member> members = memberService.findMembers(); // 모델에 있는 데이터를 전부 불러옴
        model.addAttribute("members", members);

        return "members/memberList";
    }
}

HTML 파일은 깃허브 참고

위 코드를 실행하고 실행 중인 자바를 내리면 데이터들이 전부 사라지므로 DB를 사용해 해결하자

📢 JPA

JPA를 사용하면 SQL과 데이터 중심의 설계에서 객체 중심의 설계로 패러다임을 전환할 수 있고 개발 생산성을 크게 높일 수 있다.

Member

@Entity
public class Member {

    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

JpaMemberRepository

public class JpaMemberRepository implements MemberRepository {

    private final EntityManager em;

    public JpaMemberRepository(EntityManager em) {
        this.em = em;
    }

    @Override
    public Member save(Member member) {
        em.persist(member);
        return member;
    }

    @Override
    public Optional<Member> findByID(Long id) {
        Member member = em.find(Member.class, id);
        return Optional.ofNullable(member);
    }

    @Override
    public Optional<Member> findByName(String name) {
        List<Member> result = em.createQuery("select m from Member m where m.name = :name", Member.class)
                .setParameter("name", name)
                .getResultList();

        return result.stream().findAny();
    }

    @Override
    public List<Member> findAll() {
        return em.createQuery("select m from Member m", Member.class)
                .getResultList(); // Member Entity를 조회하고 Member 객체 자체를 조회
    }
}

SpringConfig

@Configuration
public class SpringConfig {

    private EntityManager em;

    @Autowired
    public SpringConfig(EntityManager em) {
        this.em = em;
    }
    
    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository());
    }

    @Bean
    public MemberRepository memberRepository() {

        return new JpaMemberRepository(em);
    }
}

Service부분에 @Transactional 해주기

📢 스프링 데이터 JPA

  • 인터페이스를 통한 기본적인 CRUD
  • 메소드 이름만으로 조회 기능 제공
  • 페이징 기능 자동 제공

스프링 JPA를 사용하면 인터페이스 이름만으로도 개발이 가능해진다.

profile
김영한
이전 포스트

스프링 입문

다음 포스트

Spring 웹 계층

0개의 댓글