Легкая альтернатива JAX-RS

HTTP-RPC — это платформа с открытым исходным кодом для упрощения разработки приложений REST. Он позволяет разработчикам получать доступ к веб-службам на основе REST с использованием удобной RPC-подобной метафоры, сохраняя при этом основные принципы REST, такие как отсутствие состояния и постоянный доступ к ресурсам. В настоящее время проект включает поддержку использования веб-сервисов в Objective-C / Swift и Java (включая Android), что упрощает взаимодействие со службами независимо от целевого устройства или операционной системы.

HTTP-RPC также включает дополнительную поддержку для реализации служб REST в Java, обеспечивая легкую альтернативу более крупным средам REST, таким как JAX-RS. Вся платформа распространяется в виде двух файлов JAR размером около 30 КБ, что делает ее идеальным выбором для приложений, где требуется минимальная площадь.

В этой статье описывается структура сервера HTTP-RPC и дается обзор его основных функций.

DispatcherServlet

DispatcherServletабстрактный базовый класс для служб REST. Сервисные операции определяются путем добавления открытых методов к конкретной реализации сервиса.

Методы вызываются путем отправки HTTP-запроса на путь, связанный с экземпляром сервлета. Аргументы предоставляются либо через строку запроса, либо в теле запроса (например, в форме HTML), либо в виде JSON. DispatcherServletпреобразует параметры запроса в ожидаемые типы аргументов, вызывает метод и сериализует возвращаемое значение в выходной поток как JSON.

RequestMethodАннотации используются для связывания методы службы с HTTP глагола , такими как GETили POST. Необязательную ResourcePathаннотацию можно использовать, чтобы связать метод с конкретным путем относительно сервлета. Если не указан, метод связан с самим сервлетом.

@WebServlet(urlPatterns={"/math/*"})
public class MathServlet extends DispatcherServlet {
    @RequestMethod("GET")
    @ResourcePath("/sum")
    public double getSum(double a, double b) {
        return a + b;
    }

    @RequestMethod("GET")
    @ResourcePath("/sum")
    public double getSum(List values) {
        double total = 0;

        for (double value : values) {
            total += value;
        }

        return total;
    }
}

GET /math/sum?a=2&b=4

GET /math/sum?values=1&values=2&values=3

@WebServlet(urlPatterns={"/upload/*"})
@MultipartConfig
public class FileUploadServlet extends DispatcherServlet {
    @RequestMethod("POST")
    public void upload(URL file) throws IOException {
        ...
    }

    @RequestMethod("POST")
    public void upload(List files) throws IOException {
        ...
    }
}

@RequestMethod("GET")
public Map getMap() {
    return mapOf(
        entry("text", "Lorem ipsum"),
        entry("number", 123),
        entry("flag", true)
    );
}

{
    "text": "Lorem ipsum",
    "number": 123,
    "flag": true
}

protected HttpServletRequest getRequest() { ... }
protected HttpServletResponse getResponse() { ... }

@RequestMethod("GET")
@ResourcePath("/contacts/?/addresses/?")
public List<Map<String, ?>> getContactAddresses() { ... }

protected List<String> getKeys() { ... }

/contacts/jsmith/addresses/home

["jsmith", "home"]