서버 3계층 Controller Service Repository

컨트롤러, 서비스 및 리포지토리는 Java 애플리케이션에서 백엔드 아키텍처의 세 가지 중요한 구성 요소입니다. 각 구성 요소는 특정 용도로 사용되며 응용 프로그램의 논리를 관리 가능하고 재사용 가능한 단위로 구성하는 데 도움이 됩니다.

Controller

컨트롤러는 클라이언트로부터 들어오는 요청을 처리하고 처리하며 적절한 응답을 반환하는 역할을 합니다. 일반적인 RESTful API에서 컨트롤러는 들어오는 모든 HTTP 요청에 대한 진입점 역할을 합니다. 다음은 Java 컨트롤러의 예입니다.

@RestController
@RequestMapping("/api")
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping("/users/{id}")
    public ResponseEntity<User> getUserById(@PathVariable Long id) {
        User user = userService.getUserById(id);
        if (user != null) {
            return ResponseEntity.ok(user);
        } else {
            return ResponseEntity.notFound().build();
        }
    }
}

이 예제에서는 ID로 사용자를 검색하기 위해 들어오는 요청을 처리하는 UserController라는 컨트롤러를 정의했습니다. @RestController 및 @RequestMapping 주석은 이 컨트롤러의 끝점을 정의하는 데 사용되고 @Autowired 주석은 UserService의 인스턴스를 컨트롤러에 주입하는 데 사용됩니다. getUserById 메서드는 들어오는 요청을 처리하고 UserService에서 적절한 메서드를 호출하여 사용자를 검색하고 클라이언트에 응답을 반환합니다.

RESTful API

RESTful API(Representational State Transfer Application Programming Interface)는 HTTP 프로토콜과 함께 사용하도록 설계된 웹 API(Application Programming Interface) 유형입니다. HTTP 요청을 사용하여 데이터에 대한 CRUD(만들기, 읽기, 업데이트 및 삭제) 작업을 수행하는 웹 서비스를 설계하기 위한 일련의 지침 및 원칙입니다. “RESTful”이라는 용어는 HTTP 사양 작성자 중 한 명인 Roy Fielding이 2000년에 처음 도입했습니다.

RESTful API는 애플리케이션 상태를 전송하기 위해 균일한 인터페이스, 상태 비저장 상호 작용 및 하이퍼미디어 사용을 강조하는 REST 아키텍처 스타일의 원칙을 따릅니다. 즉, RESTful API의 각 리소스는 고유한 URI(Uniform Resource Identifier)로 식별되며 API는 이러한 리소스에서 CRUD 작업을 수행하기 위해 HTTP 메서드(GET, POST, PUT, DELETE 등) 집합을 제공합니다.

다음은 ID로 사용자를 검색하기 위한 RESTful API 끝점의 예입니다.

GET /api/users/123

이 예에서는 HTTP GET 메서드를 사용하여 ID가 123인 사용자를 검색합니다. /api/users/123 URI는 사용자 리소스를 고유하게 식별하고 API는 JSON과 같은 형식의 사용자 데이터로 응답합니다. 또는 XML.

RESTful API 사용의 주요 이점 중 하나는 클라이언트와 서버 간의 표준 통신 방법을 제공하여 다른 시스템 및 도구와 쉽게 통합할 수 있다는 것입니다. 표준 HTTP 메서드와 URI를 사용하므로 HTTP를 지원하는 모든 프로그래밍 언어나 프레임워크를 사용하여 액세스할 수 있습니다. 또한 RESTful API의 상태 비저장 특성으로 인해 각 요청이 독립적이고 서버 측 상태에 의존하지 않기 때문에 쉽게 확장하고 유지 관리할 수 있습니다.

요약하면 RESTful API는 REST 아키텍처 스타일의 원칙을 따르는 웹 API 유형입니다. HTTP 메서드와 URI를 사용하여 클라이언트와 서버 간에 통신하는 표준 방법을 제공하므로 다른 시스템 및 도구와 쉽게 통합할 수 있습니다.

CRUD

CRUD는 Create, Read, Update, Delete의 약자입니다. 데이터베이스 또는 기타 영구 스토리지 시스템에서 데이터를 관리하는 데 일반적으로 사용되는 일련의 기본 작업입니다. CRUD 작업은 데이터에 대해 수행할 수 있는 기본 작업(새 데이터 만들기, 기존 데이터 읽기, 기존 데이터 업데이트 및 더 이상 필요하지 않은 데이터 삭제)에 해당합니다.

각 CRUD 작업에 대한 간략한 개요는 다음과 같습니다.

1. 생성: 생성 작업은 스토리지 시스템에 새 데이터를 추가하는 데 사용됩니다. 여기에는 일반적으로 데이터가 포함된 새 레코드 또는 개체를 만든 다음 스토리지 시스템에 삽입하는 작업이 포함됩니다. 예를 들어 웹 애플리케이션은 사용자가 개인 정보를 등록 양식에 입력하여 새 계정을 만들 수 있도록 허용할 수 있습니다.
   
2. 읽기: 읽기 작업은 스토리지 시스템에서 데이터를 검색하는 데 사용됩니다. 여기에는 일반적으로 특정 사용자 ID 또는 날짜 범위와 같은 특정 기준과 일치하는 레코드 또는 개체에 대해 스토리지 시스템을 쿼리하는 작업이 포함됩니다. 예를 들어 웹 애플리케이션은 사용자가 데이터베이스에서 계정 데이터를 검색하여 계정 세부 정보를 볼 수 있도록 허용할 수 있습니다.
   
3. 업데이트: 업데이트 작업은 스토리지 시스템의 기존 데이터를 수정하는 데 사용됩니다. 여기에는 일반적으로 업데이트가 필요한 레코드나 개체를 선택하고 데이터를 변경한 다음 업데이트된 데이터를 스토리지 시스템에 다시 저장하는 작업이 포함됩니다. 예를 들어 웹 애플리케이션은 사용자가 계정 레코드의 데이터를 수정하여 계정 정보를 업데이트하도록 허용할 수 있습니다.
   
4. 삭제: 삭제 작업은 스토리지 시스템에서 데이터를 제거하는 데 사용됩니다. 여기에는 일반적으로 더 이상 필요하지 않은 레코드나 개체를 선택한 다음 스토리지 시스템에서 제거하는 작업이 포함됩니다. 예를 들어 웹 애플리케이션은 사용자가 데이터베이스에서 계정 레코드를 제거하여 계정을 삭제할 수 있도록 허용할 수 있습니다.
   

CRUD 작업은 많은 유형의 소프트웨어 시스템의 기본이며 다른 작업 및 워크플로와 함께 사용되어 더 복잡한 작업을 수행하는 경우가 많습니다. 많은 최신 웹 프레임워크 및 라이브러리는 CRUD 작업을 수행하기 위한 기본 제공 지원을 제공하므로 데이터베이스 및 기타 스토리지 시스템과 상호 작용하는 웹 애플리케이션을 보다 쉽게 구축할 수 있습니다.

JSON

JSON(JavaScript Object Notation)은 사람이 읽고 쓰기 쉽고 기계가 구문 분석하고 생성하기 쉬운 경량 데이터 교환 형식입니다. 키는 문자열이고 값은 문자열, 숫자, 개체, 배열 또는 부울 값일 수 있는 키-값 쌍의 컬렉션으로 데이터를 나타내는 텍스트 기반 형식입니다.

다음은 JSON 개체의 예입니다.

{
  "name": "John Doe",
  "age": 30,
  "email": "johndoe@example.com",
  "address": {
    "street": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "zip": "12345"
  },
  "hobbies": [
    "reading",
    "hiking",
    "traveling"
  ]
}

이 예에서는 John Doe라는 사람을 나타내는 JSON 개체를 정의했습니다. 개체에는 사람의 이름, 나이, 이메일 주소 및 주소 정보를 비롯한 여러 키-값 쌍이 포함되어 있습니다. 주소 정보는 중첩된 JSON 객체로 표현되고, 그 사람의 취미는 문자열의 배열로 표현됩니다.

JSON은 웹 서비스와 애플리케이션 간에 데이터를 교환하는 데 널리 사용되는 형식이며 프로그래밍 언어와 프레임워크에서 널리 지원됩니다. HTTP 요청에 대한 응답으로 반환되는 데이터를 나타내기 위해 RESTful API에서 자주 사용됩니다.

Java에서 JSON 데이터를 구문 분석하려면 javax.json 패키지의 내장 JSON 클래스를 사용할 수 있습니다. 다음은 위의 JSON 개체를 구문 분석하는 예입니다.

String json = "{\"name\":\"John Doe\",\"age\":30,\"email\":\"johndoe@example.com\",\"address\":{\"street\":\"123 Main St\",\"city\":\"Anytown\",\"state\":\"CA\",\"zip\":\"12345\"},\"hobbies\":[\"reading\",\"hiking\",\"traveling\"]}";
JsonReader reader = Json.createReader(new StringReader(json));
JsonObject object = reader.readObject();
String name = object.getString("name");
int age = object.getInt("age");
String email = object.getString("email");
JsonObject address = object.getJsonObject("address");
String street = address.getString("street");
String city = address.getString("city");
String state = address.getString("state");
String zip = address.getString("zip");
JsonArray hobbies = object.getJsonArray("hobbies");

이 예에서는 이전 예와 동일한 객체를 나타내는 JSON 문자열을 정의했습니다. 그런 다음 JsonReader 클래스를 사용하여 JSON 문자열을 JsonObject로 구문 분석하고 적절한 메서드를 사용하여 각 키의 값을 검색합니다. 예를 들어 getString 메서드를 사용하여 사람의 이름을 검색하고 getInt 메서드를 사용하여 사람의 나이를 검색합니다. 또한 getJsonObject 메서드를 사용하여 중첩된 주소 개체를 검색하고 getJsonArray 메서드를 사용하여 취미 배열을 검색합니다.

Service

서비스는 데이터베이스 작업 및 기타 복잡한 계산 수행과 같은 애플리케이션의 비즈니스 논리 구현을 담당합니다. 이 서비스는 종종 데이터 액세스 계층을 캡슐화하는 데 사용되므로 데이터베이스 스키마 또는 데이터 액세스 논리를 변경해도 애플리케이션의 나머지 부분에 영향을 미치지 않습니다. 다음은 Java 서비스의 예입니다.

@Service
public class UserService {
    @Autowired
    private UserRepository userRepository;

    public User getUserById(Long id) 
        return userRepository.findById(id).orElse(null);
    }
}

이 예제에서는 데이터베이스에서 사용자 검색을 담당하는 UserService라는 서비스를 정의했습니다. @Service 어노테이션은 클래스를 서비스로 표시하는 데 사용되고 @Autowired 어노테이션은 UserRepository의 인스턴스를 서비스에 주입하는 데 사용됩니다. getUserById 메서드는 UserRepository를 사용하여 데이터베이스 쿼리를 수행하여 지정된 ID를 가진 사용자를 검색합니다.

annotation

Java에서 주석은 동작 및 사용에 대한 추가 정보를 제공하기 위해 클래스, 메소드 및 필드와 같은 코드 요소에 추가할 수 있는 메타데이터 형식입니다. 주석은 @ 기호 다음에 주석 이름을 사용하여 정의되며 추가 정보를 지정하는 하나 이상의 매개변수를 가질 수 있습니다.

주석은 Java 프레임워크 및 라이브러리에서 광범위하게 사용되어 구성 정보를 제공하고 런타임 동작을 나타내며 코드의 사용자 정의를 가능하게 합니다. 다음은 Java에서 주석을 일반적으로 사용하는 몇 가지 예입니다.

1. 구성: 주석을 사용하여 애플리케이션 또는 라이브러리에 구성 정보를 제공할 수 있습니다. 예를 들어 Spring Framework의 @Component 주석은 클래스를 Spring 컨테이너에서 자동으로 스캔하고 인스턴스화해야 하는 구성 요소로 표시하는 데 사용됩니다.
   
2. 문서: 주석은 코드 요소에 대한 문서를 제공하는 데 사용할 수 있습니다. 예를 들어 @Deprecated 주석은 메소드나 클래스가 더 이상 권장되지 않으며 사용을 피해야 함을 나타냅니다.
   
3. 유효성 검사: 주석은 런타임 시 입력 매개변수 또는 기타 조건의 유효성을 검사하는 데 사용할 수 있습니다. 예를 들어 Hibernate Validator 라이브러리의 @NotNull 주석은 매개변수가 null이 아닌지 확인하는 데 사용됩니다.
   
4. 테스트: 주석은 JUnit 또는 TestNG와 같은 테스트 프레임워크와 함께 사용할 테스트 클래스 또는 메서드를 표시하는 데 사용할 수 있습니다. 예를 들어 JUnit의 @Test 주석은 테스트 프레임워크에서 실행해야 하는 테스트 메서드로 메서드를 표시하는 데 사용됩니다.
   

주석은 새로운 주석 유형을 정의하는 @interface 키워드를 사용하여 프로그래머가 정의할 수 있습니다. 다음은 맞춤 주석을 정의하는 예입니다.

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LogExecutionTime {
}

이 예제에서는 실행 시간이 지정된 것으로 메서드를 표시하는 데 사용할 수 있는 @LogExecutionTime이라는 사용자 지정 주석을 정의했습니다. @Retention 어노테이션은 어노테이션이 런타임에 유지되어야 함을 지정하고 @Target 어노테이션은 어노테이션이 메소드에만 적용될 수 있음을 지정합니다.

리플렉션과 함께 주석을 사용하여 런타임 시 코드 동작을 검사하고 수정할 수 있습니다. 예를 들어 리플렉션을 사용하여 메서드에 @LogExecutionTime 주석이 있는지 확인한 다음 실행 시간을 정할 수 있습니다. 다음은 @LogExecutionTime 주석을 사용하는 예입니다.

@LogExecutionTime
public void expensiveOperation() {
    // code to perform an expensive operation
}

이 예에서 우리는 @LogExecutionTime 주석을 사용하여 비용이 많이 드는 작업이라는 메서드를 표시했습니다. 이 메서드가 호출되면 리플렉션을 사용하여 주석이 있는지 확인한 다음 메서드 실행 시간을 측정할 수 있습니다.

Repository

리포지토리는 응용 프로그램의 데이터베이스에서 CRUD(만들기, 읽기, 업데이트, 삭제) 작업을 수행하는 역할을 합니다. 데이터베이스에 대한 추상화 계층을 제공하므로 애플리케이션의 나머지 부분이 기본 SQL 또는 데이터베이스 스키마를 알 필요 없이 높은 수준의 메서드를 사용하여 데이터베이스와 상호 작용할 수 있습니다. 다음은 Java 저장소의 예입니다.

@Repository
public interface UserRepository extends JpaRepository<User, Long> {
}

이 예제에서는 JpaRepository 인터페이스를 확장하는 UserRepository라는 리포지토리를 정의했습니다. @Repository 주석은 인터페이스를 저장소로 표시하는 데 사용되며 JpaRepository 인터페이스는 User 엔터티에서 CRUD 작업을 수행하기 위한 고급 메서드 집합을 제공합니다. 이 인터페이스를 확장하면 서비스에서 이러한 메서드를 사용하여 데이터베이스와 상호 작용할 수 있습니다.

결론

컨트롤러, 서비스 및 리포지토리는 Java 애플리케이션에서 백엔드 아키텍처의 세 가지 중요한 구성 요소입니다. 컨트롤러는 들어오는 요청을 처리하고 응답을 반환하고, 서비스는 비즈니스 로직을 구현하고 데이터 액세스 계층을 캡슐화하며, 리포지토리는 데이터베이스에 대한 추상화 계층을 제공합니다. 응용 프로그램의 논리를 이러한 관리 및 재사용 가능한 단위로 구성하여 확장 가능하고 유지 관리 가능한 Java 응용 프로그램을 만들 수 있습니다.