[JAVA] Résumé de ce que j'ai appris sur Spring Boot

introduction

Je garderai un mémorandum de ce que j'ai appris lorsque j'ai touché Spring Boot pour la première fois de novembre à décembre l'année dernière.

• C'est juste un mémorandum

Public cible

Pour ceux qui veulent toucher Spring Boot à partir de maintenant. Je pense qu'il sera connu de ceux qui l'ont utilisé.

Ce que j'ai fait

Une API publique externe simple qui renvoie simplement des informations basées sur la valeur d'entrée reçue.

Diverses choses utilisées

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

Configuration de l'application implémentée cette fois

Aperçu des différentes classes

Descriptions et échantillons de différentes classes

Classe principale

Ajoutez @ SpringBootApplication.

• Équivalent à l'état avec les trois annotations suivantes.

Diverses classes sont lues et définies par @ ComponentScan et @ EnableAutoConfiguration, et l'application est exécutée.

• Par défaut, les classes dans la même hiérarchie que la classe avec @ ComponentScan et les packages dans la hiérarchie en dessous seront analysés, donc les classes au-dessus de la classe avec @ ComponentScan seront analysées. Pas lu.

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);
    }
}

Classe RestController

• Ajoutez l'annotation @ RestController. Cible de @ ComponentScan.
• Une classe qui implémente la partie interface de l'API. Examinez la valeur d'entrée et appelez divers composants et renvoyez une réponse au client.
• Définissez la méthode HTTP et le mappage d'URL pour chaque méthode, et mappez la demande et la méthode appelée.
• Définissez la classe Form à utiliser pour gérer les demandes reçues et les réponses renvoyées pour chaque méthode.

SampleController.java

/**
 *Contrôleur d'échantillon.
 */
@RestController
@Validated
public class SampleController {

    @Autowired
    private SampleService service; //Associez la classe Service à utiliser.

    @PostMapping (path = "/sample", //Spécifiez le chemin à mapper vers la méthode.
        consumes = MediaType.APPLICATION_JSON_UTF8_VALUE, //Spécifiez le type de support de la demande à recevoir.
        produces = MediaType.APPLICATION_JSON_UTF8_VALUE) //Spécifiez le MediaType de la réponse à renvoyer.
    @CrossOrigin
    public ResponseEntity<SampleForm> sampleMethod (
        @RequestHeader (value = "sample_key") //Définissez la valeur clé de la valeur reçue de l'en-tête.
        @NotEmpty (message = "sample_key is empty.") //Si vous souhaitez examiner sans utiliser Form, définissez le contrôle ici.
        @Valid String sampleKey, //Définissez une variable qui stocke la valeur reçue de l'en-tête.
        @RequestBody
        @Valid SampleForm form //Définissez la classe Form qui stocke la valeur reçue du corps et la variable qui la stocke.
    ) {
        return new ResponseEntity<> (service.sampleMethod (form.getSampleUserId), HttpStatus.OK);
    }
}

Classe de formulaire

• Une classe qui contient des informations sur le contenu des demandes des clients et la réponse renvoyée.
• Les détails de l'examen sont décrits ici.
• En plus de la définition du contrôle par annotation, vous pouvez également définir votre propre méthode de contrôle.

SampleForm.java

@Data
@ToString
public class SampleForm implements Serializable {

    private static final long serialVersionUID = 1L;

    @JsonProperty ("sample_user_id") //Définissez la valeur de clé sur JSON.
    @NotEmpty (message = "sampleUserId is empty") //Définissez le contenu de l'examen.
    private String sampleUserId;
    
}

Classe RestControllerAdvice

• Ajoutez @ RestControllerAdvice. Cible de @ ComponentScan.
• Un traitement commun peut être implémenté dans la classe RestController. (Pré-traitement, gestion des erreurs, etc.)
• En préparant une méthode avec @ ExceptionHandler, la gestion des erreurs est automatiquement effectuée lorsque l'exception spécifiée est levée.

SampleExceptionHandler.java

@RestControllerAdvice
public class SampleExceptionHandler {

    @ExceptionHandler (Exception.class) //Définissez l'exception à capturer.
    @ResponseStatus (HttpStatus.INTERNAL_SERVER_ERROR) //Définissez le code d'état HTTP de la réponse renvoyée lorsque l'exception ci-dessus se produit.
    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;
    }
}

Classe de service

• Ajoutez @ Service. Cible de @ ComponentScan.
• Une classe qui implémente la logique métier. Effectue divers calculs et accès à la base de données en fonction de la valeur d'entrée reçue de la classe RestController.
• Puisque Spring Data JPA a été utilisé cette fois, l'accès à la base de données est effectué en appelant la classe de référentiel.

SampleService.java

@Service
@Transactional //Annule automatiquement lorsqu'une exception se produit.
public class SampleService {

    @Autowired
    private SampleUserRepository sampleUserRepository; //Associez la classe Repository à utiliser.

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

Classe de référentiel

• Ajoutez @ Repository. Cible de @ ComponentScan.
• Dans une classe qui effectue un accès à la base de données, si vous utilisez Spring Data JPA, vous pouvez exécuter un CRUD simple en implémentant uniquement l'interface.
• Hériter de JpaRepository et définir la table à laquelle accéder.
• En attribuant un nom de méthode selon la convention de dénomination, il lira automatiquement de quel CRUD il s'agit et quelles sont les conditions de recherche.
  Exemple) Si findByUserId (String userId) est défini, la méthode recherchera par userId.
• Si vous essayez d'implémenter une requête ou une recherche avec une jointure de table, ce n'est pas si simple, mais je ne l'ai pas utilisé cette fois, donc je l'omettrai.

SampleUserRepository.java

@Repository
public interface SampleUserRepository extends JpaRepository<SampleUser, String> { //Définissez la table de destination d'accès et le type de clé primaire.
    SampleUser findBySampleUserId (String sampleUserId); //Définissez les noms de méthode et les arguments selon les conventions de dénomination.
}

Classe d'entité

• Ajoutez @ Entity.
• Contient les données acquises du DB et les données à entrer dans le DB.
• Cette fois, je l'ai attaché à la table en tête-à-tête.

SampleUser.java

@Entity
@Table (name = "sample_user") //Définissez le nom de la table à lier.
@Data
public class SampleUser implements Serializable {

    private static final long serialVersionUID = 1L;

    /**Exemple d'ID utilisateur*/
    @Id //Affecté à l'élément de la clé primaire.
    @GeneratedValue (strategy = GenerationType.IDENTITY) //Si vous souhaitez une numérotation automatique, définissez la méthode de numérotation.
    private String sampleUserId;

    /**Exemple de nom d'utilisateur*/
    private String sampleUserName;
}

Site de référence

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