[JAVA] Mémorandum d'annotation de printemps-Il y a aussi lombok-

Titre

Mémorandum d'annotation de printemps

Aperçu

• J'ai résumé les annotations qui ont été publiées lors de l'apprentissage de Spring Boot en guise de rappel.
• Pour chaque annotation, vous pouvez facilement organiser vous-même le contenu recherché.
• Veuillez noter que diverses annotations telles que Spring boot et lombok sont collectées.
• La déclaration de package et la déclaration d'importation dans les exemples de phrases sont omises.

Depuis que j'apprends, je pense qu'il y a beaucoup de malentendus et de manque d'explication, alors j'apprécierais que quelqu'un le remarque. De plus, si vous savez quelque chose qui n'est pas mentionné et dont il est utile de se souvenir, veuillez commenter ~~ pleurer ~~.

Objectif

• Remarque
• Approfondissez votre compréhension des annotations susceptibles d'être utilisées lors de la création d'applications Web avec Spring Boot

table des matières

Classer dans les endroits susceptibles d'être fréquemment utilisés (* Utilisé dans une classe spécifique, non disponible)

1. Controller 　1. @Controller 　2. @RequestMapping 　3. @ResponseBody 　4. @PostMapping 　5. @GetMapping 　6. @PathVariable 　7. @RequestParam 　8. @Autowired 　9. @Value

2. Service 　1. @Service 　2. @Transactional

3. Repository 　1. @Repository

4. Component 　1. @Component 　2. @Data

5. Controller Contrôlez la transition de l'écran (mappage des demandes) et appelez le service.

1-1. @Controller

Quand l'utilisez vous?

• Lorsque vous souhaitez définir une classe de contrôleur dans Spring MVC.

Diverses explications

• Indique que le composant est traité comme une classe de contrôleur.
• Accordez à la classe que vous souhaitez gérer en tant que classe de contrôleur.

Exemple de phrase

ExampleController.java

@Controller
public class ExampleController {
	//Omission
}

référence

• Lire le document Spring MVC "Implémentation d'un contrôleur" (1)

1-2. @RequestMapping(value="URL")

Quand l'utilisez vous?

• Lorsque vous souhaitez mapper une classe ou une méthode sur une URL.

Diverses explications

• Lorsque l'URL définie dans value est spécifiée, la classe ou la méthode annotée est appelée.
• La valeur de retour renvoie la vue en spécifiant la chaîne de caractères correspondant au chemin de la vue. [Voir 1-3. @ ResponseBody si vous voulez renvoyer autre chose qu'une vue]
• Lorsqu'il est utilisé dans une classe, il peut correspondre au préfixe de l'URL (chemin parent).
• Lorsqu'il est utilisé dans une méthode, vous pouvez également spécifier un chemin relatif à partir du chemin parent. (Le pass absolu est également possible)

Attribut qui peut être spécifié

• value Spécifiez le chemin de l'URL. Le nom d'attribut peut être omis si aucun autre attribut n'est spécifié
  [@RequestMapping(value="URL") ⇒ @RequestMapping("URL")]
• method Spécifiez les attributs de méthode tels que GET et POST.
  [@ RequestMapping (value =" URL "method = RequestMethod.POST)
  Si vous en spécifiez plusieurs, cela devient une condition OR.
  [@ RequestMapping (value =" URL "method = {RequestMethod.POST, RequestMethod.GET})
• headers

Vous pouvez spécifier l'en-tête HTTP.

Il semble. Pour plus de détails, reportez-vous à [Référence: méthode de mappage entre la méthode de traitement du contrôleur et la requête (URL, etc.)]

• params

Vous pouvez spécifier des paramètres de demande. Il semble. (Voir référence pour plus de détails)

Exemple de phrase

ExampleController.java

@Controller
@RequestMapping(value="/example")
public class ExampleController {

	@RequestMapping("sample") //Http dans l'URL://xxxx:xxxx/example/Appelé lorsque l'échantillon est exécuté.(Chemin relatif)
	public String sampleMethod() {
		return "example/sample"; //Si la structure de répertoires est la structure par défaut, src/templates/example/sample.Renvoie du HTML
	}
}

référence

• [Méthode de mappage entre la méthode de traitement du contrôleur et la requête (URL, etc.)](https://sites.google.com/site/soracane/home/springnitsuite/spring-mvc/07-controllerno-chu-limesoddotonomappingu-fang- FA)
• [Spring MVC] @RequestMapping Basics

1-3. @ResponseBody

Quand l'utilisez vous?

Lorsque vous voulez retourner une vue autre que la vue correspondant au chemin du modèle avec @ RequestMapping. (Demande de mappage sans transition de page, etc.)

Diverses explications

• Si @ RequestMapping est défini, donnez-le à la méthode que vous souhaitez renvoyer autre que la vue.

Exemple de phrase

ExampleController.java

@Controller
@RequestMapping(value="/example")
public class ExampleController {

	@RequestMapping("/sample")
	@ResponseBody
	public String sampleMethod() {
		return "sample"; //"sample"Renvoie la chaîne littérale.
	}
}

référence

• Spring MVC Promenade ■ Applied Forest Spring-MVC Controller Return Value

1-4.@PostMapping

Quand l'utilisez vous?

• Lorsque vous souhaitez mapper une requête POST à une URL.

Diverses explications

• Synonyme de @ RequestMapping (value =" URL ", method = RequestMethod.POST).
• Meilleure lisibilité.

Exemple de phrase

ExampleController.java

@Controller
@RequestMapping("/example")
public class ExampleController {

	@PostMapping("top")
	public String top() {
		//Omission
	}
}

référence

• Annotations de base de Controller of Spring Framework | Sake, tears, Ruby, Rails

1-5. @GetMapping

Quand l'utilisez vous?

• Lorsque vous souhaitez mapper une requête GET à une URL.

Diverses explications

• Synonyme de @ RequestMapping (value =" URL ", method = RequestMethod.GET).
• Meilleure lisibilité.

Exemple de phrase

ExampleController.java

@Controller
@RequestMapping("/example")
public class ExampleController {

	@GetMapping("top")
	public String top() {
		//Omission
	}
}

référence

• Annotations de base de Controller of Spring Framework | Sake, tears, Ruby, Rails

1-6. @PathVariable

Quand l'utilisez vous?

• Lorsque vous souhaitez intégrer la valeur dans une partie de l'URL en tant que valeur de paramètre.

Diverses explications

• Une partie de l'URL peut être obtenue en tant que paramètre.
• Similaire à @ RequestParam, mais intégré directement dans l'URL de la requête.

Exemple de phrase

ExampleController.java

@Controller
@RequestMapping("/example")
public class ExampleController {
	
	//http://xxxx:xxxx/example/myPage/Appelé lorsqu'une demande telle que 12345 arrive
	//La valeur PostMapping et userId sont les clés et la valeur URL est la valeur.
	@PostMapping("myPage/{userId}")
	public String myPage(
		@PathVariable("userId") int argUserId		
	) {
		//Omission
	}	
}

référence

• Utilisez correctement @PathVariable et @RequestParam of Spring Controller | Permanent Til
• Arguments du contrôleur Spring MVC - Qiita

1-7. @RequestParam

Quand l'utilisez vous?

Lorsque vous souhaitez obtenir la valeur de paramètre donnée à l'URL.

Diverses explications

• Vous pouvez obtenir la valeur du paramètre donnée à l'URL.
• Similaire à @ PathVariable, mais avec un ajout supplémentaire à l'URL de la requête.

Exemple de phrase

ExampleController.java

@Controller
@RequestMapping("/example")
public class ExampleController {
	
	//http://xxxx:xxxx/example/account?userId=Appelé lorsqu'une demande telle que 12345 arrive
	//userId=12345 userId est la clé et 12345 est la valeur
	@PostMapping("account")
	public String top(
		@RequestParam("userId") int argUserId
	) {
		//Omission
	}
}

référence

• Utilisez correctement @PathVariable et @RequestParam of Spring Controller | Permanent Til
• Arguments du contrôleur Spring MVC - Qiita

1-8.@Autowired

Quand l'utilisez vous?

Utilisé lorsque vous souhaitez définir une instance pour une variable. (Il semble que ce n'est pas recommandé ... Recherche par injection de constructeur pour plus de détails)

Diverses explications

• Très simplement, si vous la donnez à une variable d'instance, elle sera nouvelle. (La situation réelle est différente)
  ↓ Pour plus de détails ... ↓
  

@Autowired est une annotation attachée à une variable d'instance afin de définir un objet approprié sous Spring management sur une variable. Référence: [Spring] Extrait des bases de la DI en utilisant @Autowired et @Component

J'ai trouvé cette explication la plus simple à comprendre au cours de mes recherches. (* Les objets sous gestion Spring sont reconnus comme des composants.)

• Puisque DI (Dependency Injection) est automatiquement exécuté à partir du même package, vous pouvez faire fonctionner l'instance sans vous soucier de la destination de l'implémentation.
• Un simple composant de classe créera automatiquement une instance.
• S'il s'agit d'une interface, * * Cela créera automatiquement une instance pour l'implémentation. * * (Notez que RunTimeException se produira s'il existe plusieurs destinations d'implémentation)
• Ajoutez avant le champ que vous souhaitez DI.

Exemple de phrase

CalcService.java

@Service
public interface CalcService {
	public int add(int x, int y);
}

CalcServiceImpl.java

@Service
public class CalcServiceImpl implements CalcService {
	public int add(int x, int y) {
		return x + y;
	}
}

ExampleController.java

@Controller
@RequestMapping("/example")
public class ExampleController {
	@Autowired
	CalcService calcService;

	@RequestMapping("calc")
	public String printTotal() {
		int x = 5;
		int y = 20;
		
		calcService.add(x, y);
		//(Omis)
		return "example/result"; 
	}
}

référence

• [Spring] Bases de DI utilisant @Autowired et @Component
• Spring Boot 5 Autowired et DI-Spice pendant votre temps libre

1-9. @Value

Quand l'utilisez vous?

• Lorsque vous souhaitez utiliser une valeur de réglage externe.

Diverses explications

• Remplacez la valeur définie dans le fichier de propriétés externes.
• Ajouter avant la déclaration de la variable que vous souhaitez affecter.

Exemple de phrase

Une sorte de fichier de propriété

sample.sampleId=12345
sample.samplePass=password

Sample.java

@Component
public class Sample {
	@Value("${sample.sampleId}")
	private int id;

	@Value("${sample.samplePass}")
	private String password;
}

référence

• Tout le monde est étonné de la façon dont Spring Boot lit le fichier de propriétés! !! | Blog Tagbangers
• Comprendre comment gérer les paramètres externes de Spring Boot --Qiita
• [Spring] @Value Annotation - IT Technology Comprehensive Wiki | CWiki

2.Service Fourniture de traitement métier (Business Logic).

2-1. @Service

Quand l'utilisez vous?

• Lorsque vous souhaitez définir une classe de service dans Spring MVC.

Diverses explications

• Indique que le composant est traité comme une classe de service.
• Accordez à la classe que vous souhaitez traiter comme une classe de service.

Exemple de phrase

SampleService.java

@Service
public interface SampleService {
	public void print();
}

SampleServiceImpl.java

@Service
public class SampleServiceImpl implements SampleService {
	public void print() {
		System.out.print("Hello.");
	}
}

2-2. @Transactional

Quand l'utilisez vous?

• Lorsque vous souhaitez effectuer le traitement des transactions.

Diverses explications

• Annule automatiquement lorsqu'une exception se produit. (Par défaut, lorsque RuntimeException se produit)
• En écrivant @ Transactional (rollbackFor = Exception.class), la restauration est effectuée lorsqu'une exception d'Exception à sa classe enfant se produit. Ci-dessous, cité à partir de la référence

Conditions pour que @Transactional fonctionne ・ Doit être une méthode publique de la classe DI -Appelée directement depuis une autre classe ou un framework qui est DI

Exemple de phrase

//en pensant

référence

• Comment faire fonctionner @Transactional si vous ne l'utilisez pas correctement-Qiita

Repository Fournit des classes pour la couche d'accès aux données.

3-1. @Repository

Quand l'utilisez vous?

• Lorsque vous souhaitez définir une classe de référentiel dans Spring MVC. (Classes qui effectuent un accès à la base de données, y compris DAO.)

Diverses explications

• Indique que le composant est traité comme une classe de référentiel.
• Accordez à la classe que vous souhaitez gérer en tant que classe de référentiel.

Exemple de phrase

SampleRepository.java

@Repository
public interface SampleRepository {
	public List<String> search(String keyword);
}

SampleRepositoryImpl.java

@Repository
public class SampleRepositoryImpl implements SampleRepository {
	public List<String> search(String keyword) {
		//Traitement des opérations DB
	}
}

référence

• [Spring] @Repository Annotation - IT Technology Comprehensive Wiki | CWiki
• Différences entre @Component, @Service, @Repository, @Controller --Qiita

Component

4-1. @Component

Quand l'utilisez vous?

• Lors de la manipulation en tant que composant Spring, non limité à Spring MVC.
• Lors de l'utilisation d'un composant dans un rôle autre que @ Controller, @ Service, @ Repository. (Classe d'utilité, etc.)

Diverses explications

• Indique qu'il s'agit d'un composant du conteneur DI de Spring.
• Donnez à la classe que vous souhaitez traiter comme un composant.

Exemple de phrase

Account.java

@Component
public class Account {
	private String id;
	private String name;
	
	//getter,abréviation du setter
}

référence

• Spring - Différence entre @Bean et @component dans Spring Framework | teratail
• Spring Framework Summary-About DI-Qiita
• Différences entre @Component, @Service, @Repository, @Controller --Qiita

4-2. @Data

Quand l'utilisez vous?

Lorsque vous souhaitez réduire la quantité de code dans la classe Bean.

Diverses explications

• Une annotation de lombok (lombok.Data).
• Gette et setter peuvent être omis en ajoutant.
• Remplace la méthode hashCode. (Renvoie la valeur de hachage de l'instance)
• Remplace la méthode toString. (Renvoie une représentation sous forme de chaîne de l'instance)
• Remplace la méthode d'égalité. (Juger et renvoyer l'équivalence des instances)

Exemple de phrase

Account.java

@Component
@Data
public class Account {
	private String accountId;
	private String password;
	private String firstName;
	private String lastName;
	private int age;
	
	//getter,Il n'y a pas de description du setter, mais il peut être utilisé car il est implémenté en interne.
}

référence

• Lombok- @ Data-Write si vous vous en souvenez
• Lombok qui peut réduire considérablement la quantité de code | Amoureux de Java
• Présentation de hashCode qui prend en charge Java par derrière, son mécanisme et sa méthode d'implémentation depuis les bases
• Remplacez toString () et veuillez transmettre vos informations --Qiita