[JAVA] Créer un serveur API Web avec Spring Boot

Aperçu

--Créez une API Web qui renvoie simplement une chaîne avec spring boot

environnement

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

procédure

Créer un modèle avec spring initializr

• Vous pouvez facilement créer un modèle de démarrage à ressort avec spring initializr.

1. Accédez à https://start.spring.io
2. Sélectionnez comme suit

• Project : Gradle Project
• Language : Java
• Spring Boot : 2.1.7
• Project Metadata : --Group: nom du package racine. Cette fois com.example --Artifact: nom du projet. Cette fois ʻapi--Options: pas de contact --Dépendances: les bibliothèques dépendantes peuvent être ajoutées àbuild.gradle` Cette fois, ajoutez ce qui suit --Spring Web Starter: package de base requis pour l'API Web --Lombok: une bibliothèque remplie de fonctionnalités utiles souvent utilisées en java Référence: Mémo quand j'ai touché lombok

1. Sélectionnez «Générer le projet» et téléchargez le zip
2. Décompressez le zip et placez le dossier dans un emplacement approprié --La structure des dossiers ressemble à ceci

.
├── 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

Préférences Intellij IDEA

--Définissez l'IDE de sorte que le zip créé précédemment puisse être modifié avec Intellij IDEA.

1. Après avoir lancé Intellij IDEA, sélectionnez ʻimport project` et sélectionnez le dossier que vous venez de décompresser.
2. Sélectionnez gradle dans ʻImport project from external model`
3. Cochez «Utiliser l'importation automatique»
4. Assurez-vous que la Gradle JVM est Java 12
5. Sélectionnez Terminer
6. Dans Preference-> Build, Execution, Deployment-> compiler-> annotation processor Cochez «Activer le traitement des annotations» et enregistrez
7. Ouvrez les paramètres du projet avec command +; et ouvrez les paramètres du projet. Sélectionnez 12 pour chacun des «Project SDK» et «Project language level» et enregistrez

Vérification de build.gradle

• Les dépendances de projet sont définies dans build.gradle

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, ʻapply plugin: paramètres du plugin --java: java Vous pourrez effectuer des tâches telles que la compilation du code source et les tests unitaires. --ʻOrg.springframework.boot: vous permet d'effectuer des tâches de démarrage de printemps telles que bootRun --ʻIo.spring.dependency-management: Fournit la fonctionnalité de nomenclature de maven (la capacité de résoudre les versions de bibliothèques dépendantes) introuvable dans gradle -- groupe, version: paramètres du projet --suceCompatibility: Spécifiez la version du JDK utilisé dans le projet --Change de «1.8» à «12» pour utiliser Java 12 cette fois. --repositories: Spécifiez le référentiel pour obtenir les bibliothèques dépendantes --dependencies: Définition des dépendances externes. Le Spring Web Starter spécifié dans initializr est reflété ici. --ʻImplementation: utilisé au moment de la compilation et de l'exécution --testImplementation: utilisé au moment de la compilation et au moment de l'exécution pendant les tests

Lancer l'application

• Cliquez avec le bouton droit sur ʻApiApplication` et exécutez
• Le journal suivant est généré et Spring boot démarre.

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)

• Accédez à http: // localhost: 8080 avec votre navigateur, et si l'écran suivant s'affiche, c'est OK.

Créer un contrôleur

• J'ai créé un package appelé controller et créé une classe appelée HelloWorldController en dessous. --Changed String pour retourner hello world! Lorsqu'une requête GET arrive avec le chemin / bonjour
• Le nom de la méthode est getHello, mais tout va bien.

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

--Annotations attachées à la classe Controller qui est le point de terminaison de l'API Web REST ――Le même effet que l'ajout des deux annotations suivantes -- @ Controller: indique qu'il s'agit d'une classe de contrôleur de MVC -- @ ResponseBody: La valeur de retour de la méthode de classe donnée devient le corps de la réponse tel quel.

@RequestMapping()

--Annotation qui définit le chemin d'accès à l'API Web REST --method = RequestMethod.XXX (XXX: GET, POST, etc.) peut être assigné à chaque méthode HTTP.

Redémarrez l'application

• Redémarrez l'application et accédez à http: // localhost: 8080 / hello dans votre navigateur
• Si vous voyez "bonjour le monde!" Sur un écran blanc, c'est OK!