«REST API с Play Framework на Java»

«1. Обзор

Цель этого руководства — изучить Play Framework и научиться создавать с его помощью службы REST с помощью Java.

Мы создадим REST API для создания, извлечения, обновления и удаления записей учащихся.

В таких приложениях у нас обычно есть база данных для хранения записей об учениках. Play Framework имеет встроенную базу данных H2, а также поддержку JPA с Hibernate и другими фреймворками сохранения.

Однако, чтобы упростить задачу и сосредоточиться на самом важном, мы будем использовать простую карту для хранения объектов учащихся с уникальными идентификаторами.

2. Создание нового приложения

После того, как мы установили Play Framework, как описано в разделе «Введение в Play Framework», мы готовы создать наше приложение.

Давайте воспользуемся командой sbt для создания нового приложения с именем student-api с помощью play-java-seed: app/models и создадим Java-бин для обработки информации об учениках:

sbt new playframework/play-java-seed.g8

Теперь мы создадим простое хранилище данных — поддерживаемое HashMap — для данных учеников, с вспомогательными методами для выполнения операций CRUD:

4. Контроллеры

public class Student {
    private String firstName;
    private String lastName;
    private int age;
    private int id;

    // standard constructors, getters and setters
}

Давайте перейдем к student-api/app/controllers и создадим новый контроллер с именем StudentController.java. Мы будем шаг за шагом выполнять код.

public class StudentStore {
    private Map<Integer, Student> students = new HashMap<>();

    public Optional<Student> addStudent(Student student) {
        int id = students.size();
        student.setId(id);
        students.put(id, student);
        return Optional.ofNullable(student);
    }

    public Optional<Student> getStudent(int id) {
        return Optional.ofNullable(students.get(id));
    }

    public Set<Student> getAllStudents() {
        return new HashSet<>(students.values());
    }

    public Optional<Student> updateStudent(Student student) {
        int id = student.getId();
        if (students.containsKey(id)) {
            students.put(id, student);
            return Optional.ofNullable(student);
        }
        return null;
    }

    public boolean deleteStudent(int id) {
        return students.remove(id) != null;
    }
}

Во-первых, нам нужно настроить HttpExecutionContext. Мы реализуем наши действия с помощью асинхронного неблокирующего кода. Это означает, что наши методы действий будут возвращать CompletionStage\u003cResult\u003e, а не просто Result. Преимущество этого заключается в том, что мы можем писать длительные задачи без блокировки.

Есть только одно предостережение при работе с асинхронным программированием в контроллере Play Framework: мы должны предоставить HttpExecutionContext. Если мы не укажем контекст выполнения HTTP, мы получим печально известную ошибку «Здесь нет доступного HTTP-контекста» при вызове метода действия.

Давайте внедрим его:

Обратите внимание, что мы также добавили StudentStore и внедрили оба поля в конструктор контроллера, используя аннотацию @Inject. Сделав это, мы можем теперь приступить к реализации методов действий.

Обратите внимание, что Play поставляется с Джексоном для обработки данных, поэтому мы можем импортировать любые классы Джексона, которые нам нужны, без внешних зависимостей.

private HttpExecutionContext ec;
private StudentStore studentStore;

@Inject
public StudentController(HttpExecutionContext ec, StudentStore studentStore) {
    this.studentStore = studentStore;
    this.ec = ec;
}

Давайте определим служебный класс для выполнения повторяющихся операций. В этом случае построение HTTP-ответов.

Итак, давайте создадим пакет student-api/app/utils и добавим в него Util.java:

С помощью этого метода мы будем создавать стандартные ответы JSON с логическим ключом isSuccessful и телом ответа.

Теперь мы можем пройтись по действиям класса контроллера.

public class Util {
    public static ObjectNode createResponse(Object response, boolean ok) {
        ObjectNode result = Json.newObject();
        result.put("isSuccessful", ok);
        if (response instanceof String) {
            result.put("body", (String) response);
        } else {
            result.putPOJO("body", response);
        }
        return result;
    }
}

4.1. Действие create

Сопоставленное как действие POST, этот метод обрабатывает создание объекта Student:

Мы используем вызов из внедрённого класса Http.Request, чтобы передать тело запроса в класс JsonNode Джексона. Обратите внимание, как мы используем служебный метод для создания ответа, если тело равно null.

Мы также возвращаем CompletionStage\u003cResult\u003e, что позволяет нам писать неблокирующий код с помощью метода CompletedFuture.supplyAsync.

public CompletionStage<Result> create(Http.Request request) {
    JsonNode json = request.body().asJson();
    return supplyAsync(() -> {
        if (json == null) {
            return badRequest(Util.createResponse("Expecting Json data", false));
        }

        Optional<Student> studentOptional = studentStore.addStudent(Json.fromJson(json, Student.class));
        return studentOptional.map(student -> {
            JsonNode jsonObject = Json.toJson(student);
            return created(Util.createResponse(jsonObject, true));
        }).orElse(internalServerError(Util.createResponse("Could not create data.", false)));
    }, ec.current());
}

Мы можем передать ему любую строку или JsonNode вместе с логическим флагом для указания статуса.

Обратите также внимание на то, как мы используем Json.fromJson() для преобразования входящего объекта JSON в объект Student и обратно в JSON для ответа.

Наконец, вместо привычного нам ok() мы используем созданный вспомогательный метод из пакета play.mvc.results. Идея состоит в том, чтобы использовать метод, который дает правильный HTTP-статус для действия, выполняемого в определенном контексте. Например, ok() для статуса HTTP OK 200 и created(), когда HTTP CREATED 201 является статусом результата, как указано выше. Эта концепция будет появляться на протяжении всех остальных действий.

4.2. Действие обновления

«Запрос PUT к http://localhost:9000/ вызывает метод StudentController.update, который обновляет информацию о студенте, вызывая метод updateStudent хранилища StudentStore:

4.3. Действие извлечения

Чтобы получить учащегося, мы передаем идентификатор учащегося в качестве параметра пути в запросе GET по адресу http://localhost:9000/:id. Это вызовет действие извлечения:

public CompletionStage<Result> update(Http.Request request) {
    JsonNode json = request.body().asJson();
    return supplyAsync(() -> {
        if (json == null) {
            return badRequest(Util.createResponse("Expecting Json data", false));
        }
        Optional<Student> studentOptional = studentStore.updateStudent(Json.fromJson(json, Student.class));
        return studentOptional.map(student -> {
            if (student == null) {
                return notFound(Util.createResponse("Student not found", false));
            }
            JsonNode jsonObject = Json.toJson(student);
            return ok(Util.createResponse(jsonObject, true));
        }).orElse(internalServerError(Util.createResponse("Could not create data.", false)));
    }, ec.current());
}

4.4. Действие удаления

Действие удаления отображается на http://localhost:9000/:id. Мы предоставляем идентификатор, чтобы определить, какую запись нужно удалить:

public CompletionStage<Result> retrieve(int id) {
    return supplyAsync(() -> {
        final Optional<Student> studentOptional = studentStore.getStudent(id);
        return studentOptional.map(student -> {
            JsonNode jsonObjects = Json.toJson(student);
            return ok(Util.createResponse(jsonObjects, true));
        }).orElse(notFound(Util.createResponse("Student with id:" + id + " not found", false)));
    }, ec.current());
}

4.5. Действие listStudents

Наконец, действие listStudents возвращает список всех студентов, которые были сохранены до сих пор. Он сопоставляется с http://localhost:9000/ в качестве запроса GET:

public CompletionStage<Result> delete(int id) {
    return supplyAsync(() -> {
        boolean status = studentStore.deleteStudent(id);
        if (!status) {
            return notFound(Util.createResponse("Student with id:" + id + " not found", false));
        }
        return ok(Util.createResponse("Student with id:" + id + " deleted", true));
    }, ec.current());
}

5. Сопоставления

Настроив действия нашего контроллера, теперь мы можем сопоставить их, открыв файл student-api/conf/ маршруты и добавление этих маршрутов:

public CompletionStage<Result> listStudents() {
    return supplyAsync(() -> {
        Set<Student> result = studentStore.getAllStudents();
        ObjectMapper mapper = new ObjectMapper();
        JsonNode jsonData = mapper.convertValue(result, JsonNode.class);
        return ok(Util.createResponse(jsonData, true));
    }, ec.current());
}

Конечная точка /assets всегда должна присутствовать для загрузки статических ресурсов.

После этого мы закончили создание Student API.

GET     /                           controllers.StudentController.listStudents()
GET     /:id                        controllers.StudentController.retrieve(id:Int)
POST    /                           controllers.StudentController.create(request: Request)
PUT     /                           controllers.StudentController.update(request: Request)
DELETE  /:id                        controllers.StudentController.delete(id:Int)
GET     /assets/*file               controllers.Assets.versioned(path="/public", file: Asset)

Чтобы узнать больше об определении сопоставлений маршрутов, посетите наш учебник по маршрутизации в приложениях Play.

6. Тестирование

Теперь мы можем запускать тесты нашего API, отправляя запросы на http://localhost:9000/ и добавляя соответствующий контекст. Запуск базового пути из браузера должен вывести:

Как мы видим, тело пусто, так как мы еще не добавили никаких записей. Используя curl, давайте запустим несколько тестов (в качестве альтернативы мы можем использовать REST-клиент, такой как Postman).

Давайте откроем окно терминала и выполним команду curl, чтобы добавить ученика:

{
     "isSuccessful":true,
     "body":[]
}

Это вернет только что созданного ученика:

После выполнения вышеуказанного теста загрузится http:// localhost:9000 из браузера теперь должен дать нам:

curl -X POST -H "Content-Type: application/json" \
 -d '{"firstName":"John","lastName":"Baeldung","age": 18}' \
 http://localhost:9000/

Атрибут id будет увеличиваться для каждой новой добавляемой записи.

{ 
    "isSuccessful":true,
    "body":{ 
        "firstName":"John",
        "lastName":"Baeldung",
        "age":18,
        "id":0
    }
}

Чтобы удалить запись, мы отправляем запрос DELETE:

{ 
    "isSuccessful":true,
    "body":[ 
        { 
            "firstName":"John",
            "lastName":"Baeldung",
            "age":18,
            "id":0
        }
    ]
}

В приведенном выше тесте мы удаляем запись, созданную в первом тесте, теперь давайте создадим ее снова, чтобы мы могли протестировать метод обновления: ~~ ~

Давайте теперь обновим запись, установив для имени «Эндрю» и возраст до 30:

curl -X DELETE http://localhost:9000/0
{ 
    "isSuccessful":true,
    "body":"Student with id:0 deleted"
}

Вышеприведенный тест демонстрирует изменение значения полей firstName и age после обновления записи.

curl -X POST -H "Content-Type: application/json" \
-d '{"firstName":"John","lastName":"Baeldung","age": 18}' \
http://localhost:9000/
{ 
    "isSuccessful":true,
    "body":{ 
        "firstName":"John",
        "lastName":"Baeldung",
        "age":18,
        "id":0
    }
}

Давайте создадим несколько дополнительных фиктивных записей, мы добавим две: John Doe и Sam Baeldung:

curl -X PUT -H "Content-Type: application/json" \
-d '{"firstName":"Andrew","lastName":"Baeldung","age": 30,"id":0}' \
http://localhost:9000/
{ 
    "isSuccessful":true,
    "body":{ 
        "firstName":"Andrew",
        "lastName":"Baeldung",
        "age":30,
        "id":0
    }
}

Теперь давайте получим все записи:

curl -X POST -H "Content-Type: application/json" \
-d '{"firstName":"John","lastName":"Doe","age": 18}' \
http://localhost:9000/

curl -X POST -H "Content-Type: application/json" \
-d '{"firstName":"Sam","lastName":"Baeldung","age": 25}' \
http://localhost:9000/

С помощью приведенного выше теста, мы проверяем правильность работы действия контроллера listStudents.

curl -X GET http://localhost:9000/
{ 
    "isSuccessful":true,
    "body":[ 
        { 
            "firstName":"Andrew",
            "lastName":"Baeldung",
            "age":30,
            "id":0
        },
        { 
            "firstName":"John",
            "lastName":"Doe",
            "age":18,
            "id":1
        },
        { 
            "firstName":"Sam",
            "lastName":"Baeldung",
            "age":25,
            "id":2
        }
    ]
}

7. Заключение

В этой статье мы показали, как создать полноценный REST API с помощью Play Framework.

Как обычно, исходный код этого руководства доступен на GitHub.

«