Spring Boot 常用注解

Spring Boot 常用注解

Spring Boot 框架提供了许多注解来简化配置和开发过程。

什么是注解式编程

注解 annotation 用来定义一个类、属性和一些方法,以便程序能够被编译处理。

它相当于一个说明文件,告诉应用程序某个类或者属性是什么,要怎么处理。注解可以用于标注 包、类、方法和变量等

注解式编程是一种 基于注释的程序编码风格。它使用特定的注释来配置和定义应用程序的行为,而 不需要显式编写大量的配置代码。

比如:


public class Jimmy {

public String sayHi() {
return "Hello, Jimmy."
}
}

常用注解

注解分不同场景使用,使用在类名上,使用在方法上等。

使用在类名上的注解

注解使用位置说明 @RestController

类名上作用相当于 @ResponseBody @Controller @Controller

类名上声明此类是一个 SpringMVC Controller

对象 @Service

类名上声明一个业务处理类(实现非接口类) @Repository

类名上声明数据库访问类(实现非接口类) @Component

类名上代表其是 Spring

管理类,常用在无法用 @Service @Repository

描述的 Spring

管理类上,相当于通用的注释 @Configuration

类名上声明此类是一个配置类,常与 @Bean

配合使用 @Resource

类名上默认按 byName

自动注入 @Autowired

类名上、属性或构造函数参数上默认按 byType

自动注入 @RequestMapping

类名或方法上用在类上,则表示所有响应请求的方法都是以该地址作为父路径的 @Transactional

类名或方法上用于处理事务 @Qualifier

类名或属性上为 Bean

指定名称,随后再通过名称引用 Bean

下面我们一个个来解析:

@RestController

用于返回 JSONXML 等数据,但是不能返回 HTML 页面。相当于 @ResponseBody@Controller 合在一起的作用。

JSON – JavaScript Object Notation, JS 对象标记;XML – eXtensible Markup Language;HTML – HyperText Markup Language


public class Hello {

public String sayHi() {
return "Hello, Jimmy.";
}
}
@Controller

用于标注控制器层,在 MVC 开发模式中代表 C(控制器)。

上面 @RestController 的例子,等价于下面的写法:


public class Hello {

public String sayHi() {
return "Hello, jimmy";
}
}
@Service

用于声明一个 业务处理类(实现非接口类),用于标注服务层,处理业务逻辑。


public class ArticleServiceImpl implements ArticleService {

private ArticleRepository articleRepository;

public Article findArticleById(long id) {
return articleRepository.findById(id);
}
}
@Repository

用于标注数据访问层。


public class UserRepository {

private JdbcTemplate jdbcTemplate;

public User getUserById(long id) {
String sql = "SELECT * FROM users WHERE is = ?";
return jdbcTemplate.queryForObject(sql, new BeanPropertyRowMapper<>(User.class));
}
}
@Component

@Component 是一个通用的注释,用于标识一个类是一个组件。使用 @Component 注释的类会被框架自动扫描,并创建为一个 Bean,可以在应用程序的其他部分进行注入和使用。


public class EmailService {
public void sendEmail(String recipient, String message) {

}
}

@Compoent 没有特定的业务含义。如果在应用程序中有更具体的组件类型,如数据访问组件(@Repository),服务组件(@Service),控制器组件(@Controller)等,推荐使用更加具体的注释以更好表达其用途和语义。

@Resource

用来标记和注入依赖。它可以用于注入其他 Spring 管理的 BeanJNDI 资源、以及其他的依赖项。


public class UserService {

private UserRepository userRepository;
}
@Configuration

用于标识一个类是配置类。配置类在应用程序中扮演着重要的角色,用于定义和组织应用程序的一些配置。它作为 Bean 的载体。


public class AppConfig {

public DataSource dataSource() {

DataSource dataSource = new DataSource();
dataSource.setUrl("jdbc:mysql://localhost:3306/mydb");
dataSource.setUsername("username");
dataSource.setPassword("password");

return dataSource;
}
}
@Autowired

表示被修饰的类需要注入对象。Spring 会扫描所有被 @Autowired 标注的类,然后根据类型在 loC 容器中找到匹配的类进行注入。被 @Autowired 注释后的类不需要再导入文件。

例子见 @Repository

@Resource@Autowired 都可以用来装配 Bean

@RequestMapping

用来处理请求地址映射,用在类或者方法上。如果用在类上,则表示类中的所有响应请求的方法都是以该路径作为父路径的。

例子见 @RestController

其有六个属性:

  • Params: 指定 Request 中必须包含某些参数值,才让该方法处理
  • Headers: 指定 Request 中必须包含某些指定的 header 值,才能让该方法处理请求
  • Value: 指定请求的实际地址,指定的地址可以是 URI Template 模式
  • Method: 指定请求的 method 类型,如 GET, POST, PUT, DELETE
  • Consumes: 指定处理请求的提交内容类型 Content-Type,比如 "application/json, text/html"
  • Produces: 指定返回的内容类型。只有当 Request 请求头中的 Accept 类型包含该指定类型时才返回
@Transactional

可以将一个方法或者类标记为事务性操作。


public class UserService {

private UserRepository userRepository;

public void updateUser(User user) {

userRepository.save(user);
}
}

慎用,如果事务执行过程中报错,则需要使用 try{ } catch{ throw Exception } 捕获

@Qualifier

用于标注哪一个实现类才需要注入的。

@Qualifier 常和 @Autowored 一起使用:


public class PaymentService {

private PaymentProcessor paymentprocessor;
}

使用在方法上的注释

常用的比如:

注释使用位置说明 @RequestBody

方法参数前常用来处理 application application/xml Content-Type

类型的数据,意味着 HTTP

消息是 JSON/XML

格式,需将其转换为制定类型参数 @PathVariable

方法参数前将 URL

获取的参数映射到方法参数上 @Bean

方法上声明该方法的返回结果是一个由 Spring

容器管理的 Bean @ResponseBody

方法上通过适当的 HttpMessageConverter

将控制器中方法返回的对象转换为指定格式 (JSON/XML)

后,写入 Response

对象的 body

数据区

@RequestBody

public class UserController {

public ResponseEntity addUser( MyData myData) {

return ResponseEntity.ok("Data received");
}
}
@PathVariable

用于获取参数中的路径。


public class UserController {

public ResponseEntity getUserById( Long userId) {

return ResponseEntity.ok("User Information");
}
}

注意:

  1. @PathVariable 注解的参数名称必须与 URL 路径参数的名称相匹配。
  2. 如果参数名称与路径参数相同,则可以省略 @PathVariable 中的参数名称。
@Bean

用于封装数据,一般有 SetterGetter 方法。在 MVC 模式中对应的是 M(模型)


public class AppConfig {

public Foo foo() {
return new Foo(bar())
}
}
@ResponseBody

使用该注解后,数据直接写入输入流中, 不需要进行视图渲染


public class HelloController {

public String sayHi() {
return "Hello, Jimmy.";
}
}

其他注解

比如:

标题使用位置说明 @EnableAutoConfiguration

入口类/类名上用来提供自动配置 @SpringBootApplication

入口类/类名上用来启动入口类 Application @EnableScheduling

入口类/类名上用来开启计划任务 @EnableAsync

入口类/类名上用来开启异步注解功能 @ComponentScan

入口类/类名上用来扫描组件,可自动发现和装配一些 Bean @Value

属性上用来获取配置文件中的值

关注夏壹分享发送:资源 获取大厂面试Spring Boot 常用注解


原文始发于微信公众号(夏壹分享):Spring Boot 常用注解

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/154804.html

(0)
小半的头像小半

相关推荐

发表回复

登录后才能评论
极客之音——专业性很强的中文编程技术网站,欢迎收藏到浏览器,订阅我们!