>  기사  >  Java  >  Java API 개발에서 웹 서비스 처리를 위해 JAX-RS 사용

Java API 개발에서 웹 서비스 처리를 위해 JAX-RS 사용

PHPz
PHPz원래의
2023-06-18 08:40:371302검색

Java API 개발은 널리 사용되는 프로그래밍 방법이며 성공의 이면에는 여러 가지 요인이 있으며 그 중 하나가 웹 서비스 처리입니다. 웹 서비스 처리에서는 RESTful 웹 서비스 구현을 위한 Java 프레임워크인 JAX-RS(Java API for RESTful Web Services)를 사용할 수 있습니다. 이 기사에서는 JAX-RS의 기본 개념, 아키텍처 및 사용법을 살펴보겠습니다.

RESTful 웹 서비스란 무엇입니까

JAX-RS를 소개하기 전에 RESTful 웹 서비스의 기본 개념을 이해해야 합니다. REST는 Representational State Transfer의 약자로 표현 계층 상태 전송을 의미합니다. RESTful 웹 서비스는 HTTP 프로토콜을 기반으로 하는 서비스로 URI(Uniform Resource Identifier)를 사용하여 리소스를 나타내고 HTTP 메서드(GET, POST, PUT, DELETE)를 사용하여 리소스를 작동합니다. RESTful 웹 서비스는 HTTP 프로토콜을 사용하므로 다른 웹 애플리케이션과 쉽게 상호 작용할 수 있는 경량 서비스입니다.

JAX-RS 아키텍처

JAX-RS 프레임워크는 Java Servlet API를 기반으로 구현되므로 Java 클래스와 주석을 사용하여 RESTful 웹 서비스를 정의할 수 있습니다. 프레임워크의 핵심은 클라이언트로부터 HTTP 요청을 수신하고 이를 Java 객체로 변환하는 HTTP 서버입니다. JAX-RS에서 리소스는 RESTful 웹 서비스의 핵심이며 리소스는 메소드 모음입니다. 이러한 메서드는 HTTP 요청을 처리합니다.

JAX-RS 프레임워크는 JAX-RS API와 JAX-RS 구현이라는 두 가지 주요 부분으로 구성됩니다. JAX-RS API는 JAX-RS 사양을 정의하는 Java 인터페이스이고, JAX-RS 구현은 JAX-RS 사양을 구현하는 프레임워크입니다. 현재 Jersey, CXF, RESTeasy 등을 포함하여 많은 JAX-RS 구현이 있습니다.

JAX-RS Annotations

JAX-RS는 주로 주석을 통해 RESTful 웹 서비스를 정의합니다. 주석은 Java 코드에서 메타데이터를 추출하는 데 사용되는 기술입니다. 다음은 JAX-RS에 가장 일반적으로 사용되는 주석입니다.

  • @Path: 리소스 경로를 지정합니다. 예를 들어 @Path("/books")는 리소스 경로가 /books임을 나타냅니다.
  • @GET, @POST, @PUT, @DELETE: HTTP 메서드를 지정합니다.
  • @Produces, @Consumes: 요청 및 응답의 미디어 유형을 지정합니다.
  • @QueryParam, @PathParam, @FormParam: 쿼리 매개변수, 경로 매개변수 및 양식 매개변수를 지정합니다.

JAX-RS 예제

아래에서는 Jersey를 사용하여 간단한 RESTful 웹 서비스를 구현해 보겠습니다. 이 서비스는 두 가지 요청을 처리합니다. 하나는 모든 책을 가져오는 요청이고 다른 하나는 책 ID를 기반으로 단일 책을 가져오는 요청입니다. 이 서비스를 구현하기 위해 @Path, @GET, @Produces 주석을 사용할 것입니다.

먼저 id와 title이라는 두 가지 속성이 있는 Book 클래스를 만들어야 합니다. 그런 다음 @Path("/books") 주석으로 표시되고 getAllBooks() 및 getBookById()라는 두 가지 메서드를 포함하는 BookResource 클래스를 만들어야 합니다. getAllBooks() 메소드에서는 @GET 및 @Produces 주석을 사용하여 HTTP 메소드와 응답의 미디어 유형을 지정합니다. getBookById() 메서드에서는 @GET, @Path 및 @Produces 주석을 사용하여 HTTP 메서드, 요청 경로 및 응답 미디어 유형을 지정합니다.

public class Book {
    private int id;
    private String title;
    public Book(int id, String title) {
        this.id = id;
        this.title = title;
    }
    public int getId() {
        return id;
    }
    public String getTitle() {
        return title;
    }
}

@Path("/books")
public class BookResource {
    private static List<Book> bookList = new ArrayList<>();
    static {
        bookList.add(new Book(1, "Java SE 8"));
        bookList.add(new Book(2, "Java EE 7"));
        bookList.add(new Book(3, "Spring 5"));
    }
    @GET
    @Produces(MediaType.APPLICATION_JSON)
    public List<Book> getAllBooks() {
        return bookList;
    }
    @GET
    @Path("/{id}")
    @Produces(MediaType.APPLICATION_JSON)
    public Book getBookById(@PathParam("id") int id) {
        return bookList.stream().filter(b -> b.getId() == id).findFirst().orElse(null);
    }
}

마지막으로 localhost의 포트 8080에서 이 서비스를 실행하려면 시작 클래스를 만들어야 합니다. 우리는 URI /api를 사용하여 이 서비스에 대한 경로를 지정합니다. 예를 들어 모든 책을 가져오라는 요청은 http://localhost:8080/api/books이고, 책 ID 1을 가져오라는 요청은 http://localhost:8080/api/books/1입니다.

public class Application extends ResourceConfig {
    public Application() {
        packages("com.example.web");
    }
    public static void main(String[] args) throws Exception {
        URI baseUri = UriBuilder.fromUri("http://localhost/").port(8080).build();
        ResourceConfig config = new Application();
        HttpServer server = JdkHttpServerFactory.createHttpServer(baseUri, config, false);
        Runtime.getRuntime().addShutdownHook(new Thread(server::stop));
        server.start();
    }
}

요약

JAX-RS는 RESTful 웹 서비스를 생성하는 편리한 방법을 제공하며 Java 애플리케이션과의 통합이 매우 쉽습니다. JAX-RS API는 RESTful 웹 서비스를 정의하기 위한 일련의 주석 및 클래스를 제공하며, JAX-RS 구현은 이러한 사양을 실제 Java 코드로 변환합니다. JAX-RS를 사용하면 RESTful 웹 서비스를 더 쉽게 생성하고 배포할 수 있으므로 애플리케이션 가용성과 확장성이 향상됩니다.

위 내용은 Java API 개발에서 웹 서비스 처리를 위해 JAX-RS 사용의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명:
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.