[JAVA] [Anfänger] Versuchen Sie, die REST-API für die Todo-App mit Spring Boot zu schreiben

Nachtrag

• Ein Teil des Controller-Codes wurde behoben
• Hinzugefügt, weil die Story um die Controller-Annotation fehlte

Inhalt

• Java-Anfänger lernen den Frühling in den Sommerferien
• Spring Framework scheint eine hohe Hürde zu haben, also vorerst von Spring Boot
• Das Thema ist die REST-API der Todo-App, die Anfänger häufig verwenden

Nicht im Detail berühren

• Um Gradle
• Rund um die Datenbank
  • JPA
  • H2 Database

Hauptgeschichte

• Die Entwicklung verwendet "IntelliJ IDEA"
• Lassen Sie es Anwendungen erstellen und starten

Vorlage erstellen

• Erstellt unter https://start.spring.io/
  • Project: Gradle Project
  • Language: Java
  • Spring Boot: 2.1.8
  • Project Metadaba:
    • Group: com.example
    • Artifact: todoapp
• Optionen: Wie sie sind
  • Dependencies:
    • Spring Web
    • Spring Data JPA
    • H2 Database
    • Lombok
• Beginnen Sie mit dem Entpacken der heruntergeladenen Zip-Datei und dem Öffnen mit IntelliJ

Paketkonfiguration

• Ordnen Sie Folgendes direkt unter "com.example.todoapp" an
  • controllers
  • repositories
  • models
• Es kann "Dienste" geben, aber diesmal wird es weggelassen

Code

models

• Task.java

package com.example.todoapp.models;

import lombok.Data;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;

@Data
@Entity
public class Task {

    @Id
    @GeneratedValue
    private Long id;
    private String summary;
    private Boolean done = false;

    public Task(){}
}

• Über jede Anmerkung
  • @Data
• Definiert Setter und Getter für jedes Feld
• Definiert die Methode toString () und die Methode hashCode ()
  • @Entity
• Zeigt an, dass es sich um eine Entität handelt.
• In der Datenbank wird eine Tabelle mit Feldern dieser Klasse erstellt
  • @Id
• Geben Sie das Feld des Primärschlüssels der Entität an
  • @GeneratedValue
• Geben Sie an, wie der Primärschlüsselwert generiert werden soll
• Es scheint, dass Sie das Verhalten ändern können, indem Sie "Strategie" oder "Generator" angeben (ich habe es nicht ausprobiert).

repositories

• TaskRepository.java

package com.example.todoapp.repositories;

import com.example.todoapp.models.Task;
import org.springframework.data.jpa.repository.JpaRepository;

public interface TaskRepository extends JpaRepository<Task, Long> {
}

• Definieren Sie eine Schnittstelle, die JpaRepository erbt
• Die "CrudRepository" -Schnittstelle im Vorfahren von "JpaRepository" definiert eine Schnittstelle wie "findById"
• Ist die Implementierung "SimpleJpaRepository"?
• JpaRepository gibt die Zielentitätsklasse und ihren Primärschlüsseltyp an
• Der hier angegebene Primärschlüsseltyp wird als Argumenttyp für findById und deleteById verwendet.
• Da der Primärschlüssel der diesmal erstellten Entität "Task" vom Typ "Long" ist, geben Sie hier "Long" an.

controllers

• ApiController.java

package com.example.todoapp.controllers;

import com.example.todoapp.models.Task;
import com.example.todoapp.repositories.TaskRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import java.util.List;
import java.util.Optional;

@RestController
@RequestMapping(value = "/api")
public class ApiController {

    @Autowired
    TaskRepository taskrepo;

    @GetMapping(value = "/todos")
    public List<Task> tasklist(){
        return taskrepo.findAll();
    }

    @GetMapping(value = "todo/{id}")
    public Optional<Task> retrieve(@PathVariable Long id){
        return taskrepo.findById(id);
    }

    @PostMapping(value = "/todo")
    public ResponseEntity<Task> newTask(@RequestBody Task task){
        Task result = taskrepo.save(task);
        return new ResponseEntity<Task> (result, HttpStatus.CREATED);
    }

    @PutMapping(value = "/todo/{id}")
    public Task update(@PathVariable Long id, @RequestBody Task task){
        task.setId(id);
        return taskrepo.save(task);
    }

    @DeleteMapping(value = "/todo/{id}")
    @ResponseStatus(HttpStatus.NO_CONTENT)
    public void delete(@PathVariable Long id){
        taskrepo.deleteById(id);
    }
}

• Über jede Anmerkung
  • @RestController
• Der Rückgabewert jeder Methode wird so wie er ist zum Antworttext
• Bei Verwendung von "@ Controller" scheint der Rückgabewert der Methode in einen String umgewandelt und in die Vorlage eingebettet zu sein.
  • @RequestMapping
• Sie können den Pfad, die Methode und die Abfrageparameter der von diesem Controller akzeptierten Anforderung angeben.
  • @Autowired
• Mit registrierten Beans mit der Annotation "@ Component" verknüpfen
• Klassen mit "@ Repository" und "@ Service" haben auch intern "@ Component" hinzugefügt.
• Hier werden die Klassen, die die TaskRepository-Schnittstelle erfüllen, automatisch in taskrepo gespeichert.
  • @GetMapping, @PostMapping, @PutMapping, @DeleteMapping
• Feste Methode von @ RequestMapping
• Für "@ GetMapping", entspricht "@RequestMapping (method = RequestMethod.GET)"
  • @ResponseStatus
• Geben Sie den Standardstatuscode an
• Verwenden Sie diese Option, wenn Sie etwas anderes als "200" zurückgeben möchten?

Funktionsprüfung

Anmelden

$ curl http://localhost:8080/api/todo -XPOST -H 'Content-Type: application/json' -d '{"summary": "my first task"}' | jq .
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100    75    0    47  100    28    170    101 --:--:-- --:--:-- --:--:--   170
{
  "id": 1,
  "summary": "my first task",
  "done": false
}

Liste abrufen

$ curl http://localhost:8080/api/todos | jq .
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100    49    0    49    0     0    285      0 --:--:-- --:--:-- --:--:--   286
[
  {
    "id": 1,
    "summary": "my first task",
    "done": false
  }
]

Holen Sie sich 1

$ curl http://localhost:8080/api/todo/1 | jq .
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100    47    0    47    0     0   2045      0 --:--:-- --:--:-- --:--:--  2136
{
  "id": 1,
  "summary": "my first task",
  "done": false
}

aktualisieren

$ curl http://localhost:8080/api/todo/1 -XPUT -H 'Content-Type: application/json' -d '{"summary": "updated my task", "done": true}' | jq .
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100    92    0    48  100    44   2632   2412 --:--:-- --:--:-- --:--:--  2666
{
  "id": 1,
  "summary": "updated my task",
  "done": true
}

Löschen (Mit Statuscode prüfen, da kein Antworttext vorhanden ist)

$ curl http://localhost:8080/api/todo/1 -XDELETE -v
*   Trying ::1...
* TCP_NODELAY set
* Connected to localhost (::1) port 8080 (#0)
> DELETE /api/todo/1 HTTP/1.1
> Host: localhost:8080
> User-Agent: curl/7.54.0
> Accept: */*
>
< HTTP/1.1 204
< Date: Wed, 25 Sep 2019 15:29:37 GMT
<
* Connection #0 to host localhost left intact

Zusammenfassung

• Es war sehr einfach zu bewegen, was ich bewegen wollte
• Es gibt zu viele Arten von Anmerkungen und ich weiß nicht, was ich verwenden soll
• Vorerst möchte ich mindestens die behalten, die ich diesmal verwendet habe
• Danach wäre es schön, wenn Sie es jedes Mal überprüfen könnten, wenn Sie etwas tun