[JAVA] Zusammenfassung dessen, was ich über Spring Boot gelernt habe

Einführung

Ich werde ein Memorandum darüber aufbewahren, was ich gelernt habe, als ich Spring Boot von November bis Dezember letzten Jahres zum ersten Mal berührt habe.

• Es ist nur ein Memorandum

Zielgruppe

Für diejenigen, die Spring Boot von nun an berühren möchten. Ich denke, dass es denen bekannt sein wird, die es benutzt haben.

Was ich gemacht habe

Eine einfache externe öffentliche API, die einfach Informationen basierend auf dem empfangenen Eingabewert zurückgibt.

Verschiedene Dinge verwendet

• Java(1.8)
• Spring Boot(2.1.0)
• Spring Data JPA
• Maven(3.5.3)
• Lombok(1.18.2)

Konfiguration der Anwendung diesmal implementiert

Übersicht über verschiedene Klassen

Beschreibungen und Beispiele verschiedener Klassen

Hauptklasse

Fügen Sie "@ SpringBootApplication" hinzu.

• Entspricht dem Status mit den folgenden drei Anmerkungen.

Verschiedene Klassen werden von @ ComponentScan und @ EnableAutoConfiguration gelesen und festgelegt, und die Anwendung wird ausgeführt.

• Standardmäßig werden Klassen in derselben Hierarchie wie die Klasse mit "@ ComponentScan" und Pakete in der darunter liegenden Hierarchie gescannt, sodass Klassen über der Klasse mit "@ ComponentScan" gescannt werden. Nicht lesen.

SampleApplication.java

@SpringBootApplication
public class SampleApplication {

    public static void main (final String[] args) {
        SpringApplication.run (SampleApplication .class, args);
    }

    @Override
    protected SpringApplicationBuilder configure (final SpringApplicationBuilder builder) {
        return builder.sources (SampleApplication .class);
    }
}

RestController-Klasse

• Fügen Sie die Anmerkung "@ RestController" hinzu. Ziel von @ ComponentScan.
• Eine Klasse, die den Schnittstellenteil der API implementiert. Untersuchen Sie den Eingabewert, rufen Sie verschiedene Komponenten auf und geben Sie eine Antwort an den Client zurück.
• Definieren Sie die HTTP-Methode und die URL-Zuordnung für jede Methode und ordnen Sie die Anforderung und die aufgerufene Methode zu.
• Definieren Sie, welche Formularklasse für die Verarbeitung empfangener Anforderungen und zurückgegebener Antworten für jede Methode verwendet werden soll.

SampleController.java

/**
 *Beispielsteuerung.
 */
@RestController
@Validated
public class SampleController {

    @Autowired
    private SampleService service; //Ordnen Sie die zu verwendende Serviceklasse zu.

    @PostMapping (path = "/sample", //Geben Sie den Pfad an, der der Methode zugeordnet werden soll.
        consumes = MediaType.APPLICATION_JSON_UTF8_VALUE, //Geben Sie den Medientyp der zu empfangenden Anforderung an.
        produces = MediaType.APPLICATION_JSON_UTF8_VALUE) //Geben Sie den Medientyp der zurückzugebenden Antwort an.
    @CrossOrigin
    public ResponseEntity<SampleForm> sampleMethod (
        @RequestHeader (value = "sample_key") //Definieren Sie den Schlüsselwert des vom Header empfangenen Werts.
        @NotEmpty (message = "sample_key is empty.") //Wenn Sie ohne Verwendung des Formulars eine Prüfung durchführen möchten, definieren Sie die Prüfung hier.
        @Valid String sampleKey, //Definieren Sie eine Variable, die den vom Header empfangenen Wert speichert.
        @RequestBody
        @Valid SampleForm form //Definieren Sie die Form-Klasse, in der der vom Text empfangene Wert gespeichert ist, und die Variable, in der er gespeichert ist.
    ) {
        return new ResponseEntity<> (service.sampleMethod (form.getSampleUserId), HttpStatus.OK);
    }
}

Formularklasse

• Eine Klasse, die Informationen zum Inhalt von Anforderungen von Clients und zur zurückgegebenen Antwort enthält.
• Einzelheiten zur Prüfung werden hier beschrieben.
• Zusätzlich zur Prüfungsdefinition durch Annotation können Sie auch Ihre eigene Prüfungsmethode definieren.

SampleForm.java

@Data
@ToString
public class SampleForm implements Serializable {

    private static final long serialVersionUID = 1L;

    @JsonProperty ("sample_user_id") //Definieren Sie den Schlüsselwert in JSON.
    @NotEmpty (message = "sampleUserId is empty") //Definieren Sie den Inhalt der Prüfung.
    private String sampleUserId;
    
}

RestControllerAdvice-Klasse

• Fügen Sie "@ RestControllerAdvice" hinzu. Ziel von @ ComponentScan.
• Die allgemeine Verarbeitung kann in der RestController-Klasse implementiert werden. (Vorverarbeitung, Fehlerbehandlung usw.)
• Durch die Vorbereitung einer Methode mit "@ ExceptionHandler" wird die Fehlerbehandlung automatisch ausgeführt, wenn die angegebene Ausnahme ausgelöst wird.

SampleExceptionHandler.java

@RestControllerAdvice
public class SampleExceptionHandler {

    @ExceptionHandler (Exception.class) //Definieren Sie die zu fangende Ausnahme.
    @ResponseStatus (HttpStatus.INTERNAL_SERVER_ERROR) //Definieren Sie den HTTP-Statuscode der Antwort, die zurückgegeben wird, wenn die obige Ausnahme auftritt.
    protected ErrorForm handleInternalServerError (Exception e) {
        logger.error (e);
        return new ErrorForm ("Internal Server Error");
    }

    @RequiredArgsConstructor
    private class ErrorForm implements Serializable {
        private static final long serialVersionUID = 1L;
        private final String message;
    }
}

Serviceklasse

• Fügen Sie "@ Service" hinzu. Ziel von @ ComponentScan.
• Eine Klasse, die Geschäftslogik implementiert. Führen Sie verschiedene Berechnungen und DB-Zugriffe basierend auf dem von der RestController-Klasse empfangenen Eingabewert durch.
• Da diesmal Spring Data JPA verwendet wurde, wird der DB-Zugriff durch Aufrufen der Repository-Klasse ausgeführt.

SampleService.java

@Service
@Transactional //Rollback automatisch, wenn eine Ausnahme auftritt.
public class SampleService {

    @Autowired
    private SampleUserRepository sampleUserRepository; //Ordnen Sie die zu verwendende Repository-Klasse zu.

    public SampleForm returnSampleForm (String sampleUserId) {
        return convertToSampleForm(sampleUserRepository.findBySampleUserId(sampleUserId));
    }
}

Repository-Klasse

• Fügen Sie "@ Repository" hinzu. Ziel von @ ComponentScan.
• Eine Klasse, die DB-Zugriff ausführt. Wenn Sie Spring Data JPA verwenden, können Sie eine einfache CRUD ausführen, indem Sie nur eine Schnittstelle implementieren.
• JpaRepository erben und die Tabelle definieren, auf die zugegriffen werden soll.
• Durch Zuweisen eines Methodennamens gemäß der Namenskonvention wird automatisch gelesen, um welche CRUD es sich handelt und um welche Suchbedingungen es sich handelt.
  Beispiel) Wenn findByUserId (String userId) festgelegt ist, sucht die Methode nach userId.
• Wenn Sie versuchen, eine Abfrage zu implementieren oder mit einem Tabellen-Join zu suchen, ist dies nicht so einfach, aber ich habe es diesmal nicht verwendet, daher werde ich es weglassen.

SampleUserRepository.java

@Repository
public interface SampleUserRepository extends JpaRepository<SampleUser, String> { //Definieren Sie die Zugriffszieltabelle und den Primärschlüsseltyp.
    SampleUser findBySampleUserId (String sampleUserId); //Definieren Sie Methodennamen und Argumente gemäß den Namenskonventionen.
}

Entitätsklasse

• Fügen Sie "@ Entity" hinzu.
• Enthält von DB erfasste Daten und Daten, die in DB eingegeben werden sollen.
• Dieses Mal habe ich es eins zu eins an den Tisch gebunden.

SampleUser.java

@Entity
@Table (name = "sample_user") //Definieren Sie den zu verknüpfenden Tabellennamen.
@Data
public class SampleUser implements Serializable {

    private static final long serialVersionUID = 1L;

    /**Beispielbenutzer-ID*/
    @Id //Dem Element des Primärschlüssels zugewiesen.
    @GeneratedValue (strategy = GenerationType.IDENTITY) //Wenn Sie eine automatische Nummerierung wünschen, definieren Sie die Nummerierungsmethode.
    private String sampleUserId;

    /**Beispiel Benutzername*/
    private String sampleUserName;
}

Referenzseite

• https://docs.spring.io/spring-boot/docs/current/reference/html/index.html