Spring Boot 基础注解
最后修改于 2023 年 8 月 2 日
在本文中，我们将展示如何使用 Spring Boot 基础注解，包括 @Bean、@Service、@Configuration、@Controller、@RequestMapping、@Repository、@Autowired 和 @SpringBootApplication。
Spring 是一个流行的 Java 应用程序框架，用于创建企业级应用程序。 Spring Boot 是 Spring 框架演进的下一步。它有助于以最小的努力创建独立的、生产级的、基于 Spring 的应用程序。它不再使用 XML 配置，并实现了约定优于配置原则。
注解 是一种元数据的形式，它提供了关于程序的数据，而这些数据不属于程序本身。注解对它们所注解的代码的操作没有直接影响。
Spring Boot 基础注解
在示例应用程序中，我们有这些 Spring Boot 注解
- @Bean - 表明一个方法生成一个由 Spring 管理的 bean。
- @Service - 表明一个被注解的类是一个服务类。
- @Repository - 表明一个被注解的类是一个存储库，它是数据访问和存储的抽象。
- @Configuration - 表明一个类是一个配置类，可能包含 bean 定义。
- @Controller - 将类标记为 Web 控制器，能够处理请求。
- @RequestMapping - 将带有路径的 HTTP 请求映射到控制器方法。
- @Autowired - 标记一个构造函数、字段或 setter 方法，以便通过 Spring 依赖注入进行自动装配。
- @SpringBootApplication - 启用 Spring Boot 自动配置和组件扫描。
@Component 是一个用于 Spring 管理组件的通用原型。它在自动扫描时将类转换为 Spring bean。使用基于注解的配置和类路径扫描时，带有此注解的类被视为自动检测的候选者。@Repository、@Service 和 @Controller 是 @Component 的专门化，用于更具体的用例。
示例中还有 Hibernate 的 @Entity、@Table、@Id 和 @GeneratedValue 注解。
Spring Boot 基础注解示例
以下应用程序是一个 Spring Boot 应用程序，它使用 Spring Data JPA 从 H2 数据库返回数据。该应用程序使用 FreeMarker 作为模板引擎。
build.gradle
...
src
├── main
│ ├── java
│ │ └── com
│ │ └── zetcode
│ │ ├── Application.java
│ │ ├── controller
│ │ │ └── MyController.java
│ │ ├── model
│ │ │ └── City.java
│ │ ├── repository
│ │ │ └── CityRepository.java
│ │ └── service
│ │ ├── CityService.java
│ │ └── ICityService.java
│ └── resources
│ ├── application.yml
│ ├── import.sql
│ ├── static
│ │ └── css
│ │ └── style.css
│ └── templates
│ ├── index.ftlh
│ └── showCities.ftlh
└── test
├── java
└── resources
这是项目结构。
build.gradle
plugins {
id 'org.springframework.boot' version '3.1.1'
id 'io.spring.dependency-management' version '1.1.0'
id 'java'
}
group = 'com.zetcode'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
implementation 'org.springframework.boot:spring-boot-starter-freemarker'
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
runtimeOnly 'com.h2database:h2'
}
这是 Gradle 构建文件。它包含 Freemaker、Spring Data JPA 和 H2 数据库的依赖项。当 Spring Boot 在构建文件中找到 Freemaker 和 H2 时，它会自动配置它们。我们可以立即使用它们。
resources/application.yml
server:
servlet:
context-path: /myapp
spring:
main:
banner-mode: "off"
datasource:
platform: h2
在 application.yml 文件中，我们编写 Spring Boot 应用程序的各种配置设置。
com/zetcode/model/City.java
package com.zetcode.model;
import java.util.Objects;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import jakarta.persistence.Table;
@Entity
@Table(name = "cities")
public class City {
@Id
@GeneratedValue(strategy = GenerationType.AUTO)
private Long id;
private String name;
private int population;
public City() {
}
public City(Long id, String name, int population) {
this.id = id;
this.name = name;
this.population = population;
}
public Long getId() {
return id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getPopulation() {
return population;
}
public void setPopulation(int population) {
this.population = population;
}
@Override
public int hashCode() {
int hash = 7;
hash = 79 * hash + Objects.hashCode(this.id);
hash = 79 * hash + Objects.hashCode(this.name);
hash = 79 * hash + this.population;
return hash;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final City other = (City) obj;
if (this.population != other.population) {
return false;
}
if (!Objects.equals(this.name, other.name)) {
return false;
}
return Objects.equals(this.id, other.id);
}
@Override
public String toString() {
final StringBuilder sb = new StringBuilder("City{");
sb.append("id=").append(id);
sb.append(", name='").append(name).append('\'');
sb.append(", population=").append(population);
sb.append('}');
return sb.toString();
}
}
这是 City 实体。每个实体必须至少定义两个注解：@Entity 和 @Id。 @Entity 注解指定该类是一个实体，并映射到数据库表。@Table 注解指定用于映射的数据库表的名称。 @Id 注解指定实体的主键，@GeneratedValue 提供主键值的生成策略的规范。
resources/import.sql
INSERT INTO cities(name, population) VALUES('Bratislava', 432000);
INSERT INTO cities(name, population) VALUES('Budapest', 1759000);
INSERT INTO cities(name, population) VALUES('Prague', 1280000);
INSERT INTO cities(name, population) VALUES('Warsaw', 1748000);
INSERT INTO cities(name, population) VALUES('Los Angeles', 3971000);
INSERT INTO cities(name, population) VALUES('New York', 8550000);
INSERT INTO cities(name, population) VALUES('Edinburgh', 464000);
INSERT INTO cities(name, population) VALUES('Berlin', 3671000);
模式由 Hibernate 自动创建；之后，执行 import.sql 文件以填充表数据。
com/zetcode/repository/CityRepository.java
package com.zetcode.repository;
import com.zetcode.model.City;
import org.springframework.data.repository.CrudRepository;
import org.springframework.stereotype.Repository;
@Repository
public interface CityRepository extends CrudRepository<City, Long> {
}
@Repository 注解用于定义存储库。
com/zetcode/service/ICityService.java
package com.zetcode.service;
import com.zetcode.model.City;
import java.util.List;
public interface ICityService {
List<City> findAll();
}
ICityService 提供了一个契约方法来获取所有城市。
com/zetcode/service/CityService.java
package com.zetcode.service;
import com.zetcode.model.City;
import com.zetcode.repository.CityRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class CityService implements ICityService {
private final CityRepository cityRepository;
@Autowired
public CityService(CityRepository cityRepository) {
this.cityRepository = cityRepository;
}
@Override
public List<City> findAll() {
return (List<City>) cityRepository.findAll();
}
}
@Service 注解声明 CityService 是一个服务类：一个提供业务服务的类。可选的 @Autowired 注解将 cityRepository 字段标记为用 CityRepository 进行注入。
com/zetcode/controller/MyController.java
package com.zetcode.controller;
import com.zetcode.service.ICityService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import java.util.HashMap;
import java.util.Map;
@Controller
public class MyController {
private final ICityService cityService;
@Autowired
public MyController(ICityService cityService) {
this.cityService = cityService;
}
@RequestMapping("/")
public String index(Model model) {
return "index";
}
@RequestMapping("/cities")
public ModelAndView showCities() {
var cities = cityService.findAll();
Map<String, Object> params = new HashMap<>();
params.put("cities", cities);
return new ModelAndView("showCities", params);
}
}
@Controller 注解将类标记为 Web 控制器。 @RequestMapping 将带有路径的 HTTP 请求映射到控制器方法。在第二种情况下，它将 /cities URL 映射到 showCities 方法。
resources/templates/index.ftlh
<!DOCTYPE html>
<html>
<head>
<title>Home page</title>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<a href="cities">Show cities</a>
</body>
</html>
这是 index.ftlh 模板文件。它包含一个用于创建请求以显示所有城市的链接。
resources/templates/showCities.ftlh
<!DOCTYPE html>
<html>
<head>
<title>Cities</title>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="css/style.css">
</head>
<body>
<h2>List of cities</h2>
<table>
<tr>
<th>Id</th>
<th>Name</th>
<th>Population</th>
</tr>
<#list cities as city>
<tr>
<td>${city.id}</td>
<td>${city.name}</td>
<td>${city.population}</td>
</tr>
</#list>
</table>
</body>
</html>
这是 showCities.ftlh 模板文件。它使用 FreeMarker 的 #list 宏来显示所有 city 对象。
resources/static/css/style.css
h2 {color: blue}
td:nth-child(3) {
text-align: right;
}
这是 style.css 模板文件。
com/zetcode/Application.java
package com.zetcode;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
@SpringBootApplication 启用自动配置和组件扫描。
$ ./gradlew bootRun
我们运行该应用程序并定位到 localhost:8080/myapp 地址。
在本文中，我们介绍了几个基本的 Spring Boot 注解。