[JAVA] Erstellen Sie einen Web-API-Server mit Spring Boot

Überblick

--Erstellen Sie eine Web-API, die nur einen String mit Spring Boot zurückgibt

Umgebung

• macOS Mojave 10.14.6
• Java openjdk 12.0.1
• Spring Boot 2.1.7
• Intellij IDEA CE 2019.1

Verfahren

Erstellen Sie eine Vorlage mit spring initializr

• Mit spring initializr können Sie ganz einfach eine Vorlage für den Frühlingsstiefel erstellen.

1. Gehen Sie zu https://start.spring.io
2. Wählen Sie wie folgt

• Project : Gradle Project
• Language : Java
• Spring Boot : 2.1.7
• Project Metadata : --Gruppe: Name des Stammpakets. Diesmal com.example
• Artefakt: Projektname. Diesmal api
• Optionen: Keine Berührung
• Abhängigkeiten: Abhängige Bibliotheken können zu "build.gradle" hinzugefügt werden Fügen Sie diesmal Folgendes hinzu --Spring Web Starter: Basispaket für Web-API erforderlich --Lombok: Eine Bibliothek mit nützlichen Funktionen, die häufig in Java verwendet werden Referenz: Hinweise beim Berühren von Lombok

1. Wählen Sie "Projekt generieren" und laden Sie die Zip-Datei herunter
2. Entpacken Sie die Zip-Datei und legen Sie den Ordner an einem geeigneten Ort ab

• Die Ordnerstruktur sieht so aus

.
├── HELP.md
├── README.md
├── build.gradle
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── settings.gradle
└── src
    ├── main
    │   ├── java
    │   │   └── com
    │   │       └── example
    │   │           └── api
    │   │               └── ApiApplication.java
    │   └── resources
    │       ├── application.properties
    │       ├── static
    │       └── templates
    └── test
        └── java
            └── com
                └── example
                    └── api
                        └── ApiApplicationTests.java

Intellij IDEA-Einstellungen

• Stellen Sie die IDE so ein, dass die zuvor erstellte Zip mit Intellij IDEA bearbeitet werden kann.

1. Wählen Sie nach dem Starten von Intellij IDEA "Projekt importieren" und den Ordner aus, den Sie gerade entpackt haben.
2. Wählen Sie "Gradle" aus "Projekt aus externem Modell importieren"
3. Aktivieren Sie "Automatischen Import verwenden"
4. Stellen Sie sicher, dass die Gradle JVM Java 12 ist
5. Wählen Sie Fertig stellen
6. Klicken Sie unter Einstellungen-> Erstellen, Ausführen, Bereitstellen-> Compiler-> Anmerkungsprozessor auf Aktivieren Sie "Anmerkungsverarbeitung aktivieren" und speichern Sie sie
7. Öffnen Sie die Projekteinstellungen mit Befehl +; und öffnen Sie die Projekteinstellungen. Wählen Sie 12 für "Project SDK" und "Project Language Level" und speichern Sie

Überprüfen von build.gradle

• Projektabhängigkeiten werden in build.gradle definiert

build.gradle

plugins {
	id 'org.springframework.boot' version '2.1.7.RELEASE'
	id 'java'
}

apply plugin: 'io.spring.dependency-management'

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

repositories {
	mavenCentral()
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-web'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

--plugins, Plugin anwenden: Plugin-Einstellungen --java: java Sie können Aufgaben wie das Kompilieren von Quellcode und Unit-Tests ausführen. --org.springframework.boot: Ermöglicht das Ausführen von Spring-Boot-Aufgaben wie bootRun --io.spring.dependency-management: Bietet die Stücklistenfunktionalität von maven (die Möglichkeit, abhängige Bibliotheksversionen aufzulösen), die nicht in gradle gefunden wurden -- Gruppe, Version: Projekteinstellungen --suceCompatibility: Geben Sie die Version des im Projekt verwendeten JDK an

• Wechseln Sie von 1.8 zu 12, um diesmal Java 12 zu verwenden. --repositories: Geben Sie das Repository an, um die abhängigen Bibliotheken abzurufen --dependencies: Definition externer Abhängigkeiten. Der in initializr angegebene Spring Web Starter wird hier wiedergegeben. --implementation: Wird zur Kompilierungs- und Laufzeit verwendet --testImplementation: Wird zur Kompilierungs- und Laufzeit beim Testen verwendet

Programm starten

• Klicken Sie mit der rechten Maustaste auf "ApiApplication" und führen Sie es aus
• Das folgende Protokoll wird ausgegeben und der Spring-Start wird gestartet.

23:07:15: Executing task 'ApiApplication.main()'...

> Task :compileJava
> Task :processResources
> Task :classes

> Task :ApiApplication.main()

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.1.7.RELEASE)

2019-08-06 23:07:32.447  INFO 20662 --- [           main] com.example.api.ApiApplication           : Starting ApiApplication on xxxnoMacBook-Air.local with PID 20662 (/Users/xxx/dev/spring-boot-api/build/classes/java/main started by xxx in /Users/xxx/dev/spring-boot-api)
2019-08-06 23:07:32.452  INFO 20662 --- [           main] com.example.api.ApiApplication           : No active profile set, falling back to default profiles: default
2019-08-06 23:07:35.060  INFO 20662 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
2019-08-06 23:07:35.118  INFO 20662 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2019-08-06 23:07:35.119  INFO 20662 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.22]
2019-08-06 23:07:35.309  INFO 20662 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2019-08-06 23:07:35.309  INFO 20662 --- [           main] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 2746 ms
2019-08-06 23:07:35.680  INFO 20662 --- [           main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor'
2019-08-06 23:07:36.278  INFO 20662 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2019-08-06 23:07:36.292  INFO 20662 --- [           main] com.example.api.ApiApplication           : Started ApiApplication in 4.996 seconds (JVM running for 5.699)

• Rufen Sie mit Ihrem Browser "http: // localhost: 8080" auf. Wenn der folgende Bildschirm angezeigt wird, ist dies in Ordnung.

Controller erstellen

• Ich habe ein Paket namens "controller" erstellt und eine Klasse namens "HelloWorldController" darunter erstellt. --Changed String, um "Hallo Welt!" Zurückzugeben, wenn eine GET-Anfrage mit dem Pfad "/ Hallo" eingeht
• Der Methodenname ist "getHello", aber alles ist in Ordnung.

HelloWorldController

package com.example.api.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("hello")
public class HelloWorldController {

    @RequestMapping(method = RequestMethod.GET)
    public String getHello() {
        return "hello world!";
    }
}

@RestController

• An die Controller-Klasse angehängte Anmerkungen, die der Endpunkt der REST-Web-API ist ――Der gleiche Effekt wie das Hinzufügen der folgenden zwei Anmerkungen -- @ Controller: Zeigt an, dass es sich um eine Controller-Klasse von MVC handelt -- @ ResponseBody: Der Rückgabewert der angegebenen Klassenmethode wird so wie er ist zum Antworttext.

@RequestMapping()

• Anmerkung, die den Pfad für den Zugriff auf die REST-Web-API festlegt --method = RequestMethod.XXX (XXX: GET, POST usw.) kann jeder HTTP-Methode zugewiesen werden.

Applikation neustarten

• Starten Sie die Anwendung neu und greifen Sie in Ihrem Browser auf "http: // localhost: 8080 / hello" zu --OK wenn "Hallo Welt!" Wird auf dem weißen Bildschirm angezeigt!