Web开发中常用注解

已于 2024-03-06 20:54:43 修改
阅读量1.7k 收藏 43
点赞数 46
文章标签： java 开发语言 spring
于 2024-03-06 20:52:22 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/iranw/article/details/136517502
版权

注解

对象范围

全称

介绍

@PostConstruct

@Target(METHOD)

javax.annotation.PostConstruct
  1. PostConstruct 注解用于标记在依赖注入完成后需要执行的方法，以执行任何初始化操作。
  2. 类中只能有一个方法被标记为这个注解。
  3. 可以应用于拦截器以及普通类，执行目标为Method @Target(METHOD)
  4. PostConstruct注解应用于非拦截器类中的方法必须为无参(void)方法
  5. PostConstruct注解应用的方法可以是public, protected, package private or private
  6. 在web开发中，PostConstruct注解应用的方法不可是static静态的，但可以是final

教程：一文带你深入理解SpringBean生命周期之PostConstruct、PreDestroy详解 - 掘金

@PreDestroy

@Target(METHOD)

javax.annotation.PreDestroy

作用为：在容器销毁Bean的时候回调执行，用于释放资源

注：除作用不同外，其他注意事项同@PostConstruct注解一致

@Resource

@Target({TYPE, FIELD, METHOD})

javax.annotation.Resource
  1. @Resource和@Autowired都是做bean的注入时使用。区别在于@Autowired按byType自动注入。@Resource属于注解是属于J2EE，@Autowired注解属于Spring，推荐使用@Resource
  2. 此注解标记了应用程序需要的资源。作用于组件类、以及组件类的字段或者方法
  3. 此注解可以应用于私有字段
public class MyComponent {
    private ConnectionFactory connectionFactory;

    @Resource(name = "jdbc/MyDB")
    private DataSource dataSource;

    @Resource(name = "jms/MyFactory")
    public void setConnectionFactory(ConnectionFactory connectionFactory) {
        this.connectionFactory = connectionFactory;
    }
    // 其他代码
}

教程：@Resource注解用法_@resource使用-优快云博客

@Resources

@Target(TYPE)

javax.annotation.Resources

@Autowired

@Target({

ElementType.CONSTRUCTOR,

ElementType.METHOD,

ElementType.PARAMETER,

ElementType.FIELD,

ElementType.ANNOTATION_TYPE

})

org.springframework.beans.factory

.annotation.Autowired
  1. 可以对类成员变量、构造方法、方法进行标注，以完成自动装备的工作
  2. @Resource有两个属性name和type。Spring将@Resource注解的name属性解析为bean的名字，而type属性则解析为bean的类型。所以如果使用name属性，则使用byName的自动注入策略，而使用type属性时则使用byType自动注入策略。如果既不指定name也不指定type属性，这时将通过反射机制使用byName自动注入策略。@Autowired只根据type进行注入，不会去匹配name。如果涉及到type无法辨别注入对象时，那需要依赖@Qualifier或@Primary注解一起来修饰。

教程：@Autowired和@Resource的区别 - 掘金

@Qualifier

@Target({

ElementType.FIELD,

ElementType.METHOD,

ElementType.PARAMETER,

ElementType.TYPE,

ElementType.ANNOTATION_TYPE

})

org.springframework.beans.factory

.annotation.Qualifier
  1. 主要场景为自动装配类时可以定位具体的实现类（@Autowired按类型装配Spring Bean。 如果容器中有多个相同类型的bean，则框架将抛出NoUniqueBeanDefinitionException）
  2. 通过使用@Qualifier注解，我们可以消除需要注入哪个bean的问题
public interface Vehicle {
    String start();
    String stop();
}
//---------分割线-----------------
@Component
public class Bike implements Vehicle {
    @Override
    public String start() {
        return "Bike started";
    }

    @Override
    public String stop() {
        return "Bike stopped";
    }
}
//---------分割线-----------------
@Component
public class Car implements Vehicle {
    @Override
    public String start() {
        return  "Car started";
    }

    @Override
    public String stop() {
        return "Car stopped";
    }
}
//---------分割线 应用于属性-----------------
@Service
public class Vehicle1Service {
    
    @Autowired
    @Qualifier("bike") //如果不加次注解，将抛出异常
    private Vehicle vehicle;

    public String start() {
        return vehicle.start();
    }

    public String stop() {
        return vehicle.stop();
    }
}
//---------分割线 应用与构造方法-----------------
@Service
public class Vehicle2Service {
    
    private Vehicle vehicle;

    public VehicleService(@Qualifier("bike") Vehicle vehicle) {
        this.vehicle = vehicle;
    }

    public String start() {
        return vehicle.start();
    }

    public String stop() {
        return vehicle.stop();
    }
}

教程：https://www.cnblogs.com/CreateMyself/p/12153891.html

@Primary

@Target({

ElementType.TYPE,

ElementType.METHOD

})

org.springframework.context

.annotation.Primary
  1. 作用：当有多个相同类型的bean时，使用@Primary来赋予bean更高的优先级。
  2. @Parimary用于定义默认bean，@Qualifier用于定位具体的bean

教程：Spring中@Primary注解-优快云博客

@Component

@Target({ElementType.TYPE})

org.springframework.stereotype

.Component
  1. @Component用于将一个类标识为组件。被@Component注解的类会被自动检测，当使用基于注解的配置和类路径扫描时，它们会被视为候选对象。其他类级别的注解也可以被视为标识组件的特殊类型，比如@Repository注解或AspectJ的@Aspect注解。
  2. @Component的作用是把普通POJO实例化到Spring容器中，相当于配置文件中的，@Component 是一个泛化的概念，仅仅表示一个组件 (Bean) ，可以作用在任何层次。基于@Component注解有三个扩展，分别是：@Repository 、@Service、 @Controller。被他们四个标注的类，会被纳入到Spring容器中进行管理

@Controller

@Target({ElementType.TYPE})

org.springframework.stereotype.Controller

属于@component的扩展注解，用于标注控制层

@Service

@Target({ElementType.TYPE})

org.springframework.stereotype.Service
  1. 属于@component的扩展注解，用于标注服务层
  2. 如果你不知道要在项目的业务层采用@Service还是@Component注解。那么，@Service是一个更好的选择

@Repository

@Target({ElementType.TYPE})

org.springframework.stereotype.Repository

属于@component的扩展注解，用于标注数据访问层，也可以说用于标注数据访问组件，即DAO组件

@Value

@Target({

ElementType.FIELD,

ElementType.METHOD,

ElementType.PARAMETER,

ElementType.ANNOTATION_TYPE

})

org.springframework.beans.factory.annotation.Value
  1. 用于字段、方法/构造函数参数级别的注解，初始化影响参数的默认值表达式。可以在设置变量的时候设置默认值
  2. 配置文件支持properties、XML、和YML文件
  3. 配置支持SpEL表达式
  4. 使用方法为：
    • @Value(“常量”) 常量,包括字符串,网址,文件路径等
    • @Value(“${}”: default_value) 读取配置文件
    • @Value(“#{}”? : default_value) 读取注入bean（对象）的属性
// 注入普通字符串 
@Value("Jack")
private String username; 

// 注入文件资源
@Value("classpath:com/test/config.xml")
private Resource resource; 

// 注入URL资源
@Value("http://www.baidu.com")
private Resource url; 

//假如application.yml配置文件 有myUserName: 张三配置
//读取配置文件
@Value("${myUserName}")
private String myUserName; 

//Value(“#{}”), 用于读取bean对象的属性
@Data
@Component
public class User {
    private String id;
    // 读取配置文件数据
    @Value("${myUserName}")
    private String username ;
}
@RestController
@RequestMapping("/consumer")
@Slf4j
public class ConsumerController {
    // 读取bean属性
    @Value("#{user.username}")
    private String username;
}

教程：深度解析@Value注解，你真的彻底了解过吗？-51CTO.COM

关于Spring中@Value注解使用 - 掘金

@Configuration

@Target(ElementType.TYPE)

org.springframework.context.annotation.Configuration
  1. @Configuration是@Conponent的衍生注解，用于标识一个类作为配置类（同等于xml配置），它通常与@Bean注解一起使用，用于定义 bean 的创建和配置。这使得 Spring 能够识别并加载这些配置类，从而创建应用程序上下文并管理 bean。
  2. 应用此注解类的要求：1）不可以是final类型 2）不可以是匿名类 3）@Configuration必须是静态类

教程：SpringBoot中@Configuration注解-优快云博客

Spring管理的@Configuration注解使用 - 掘金

@Bean

@Target({

ElementType.METHOD,

ElementType.ANNOTATION_TYPE

})

org.springframework.context

.annotation.Bean
  1. @Bean注解用于告诉方法，产生一个Bean对象，然后这个Bean对象交给Spring管理。产生这个Bean对象的方法Spring只会调用一次，随后这个Spring将会将这个Bean对象放在自己的IOC容器中。
  2. @Bean注解注册bean,同时可以指定初始化和销毁方法@Bean(name="testBean",initMethod="start",destroyMethod="cleanup")
  3. name属性相当于<bean>标签的id
  4. @Bean注解在返回实例的方法上，如果未通过@Bean指定bean的名称，则默认与标注的方法名相同（第一个单词转小写）
  5. @Bean注解默认作用域为单例singleton作用域，可通过@Scope(“prototype”)设置为原型作用域
  6. 既然@Bean的作用是注册bean对象，那么完全可以使用@Component、@Controller、@Service、@Ripository等注解注册bean，当然需要配置@ComponentScan注解进行自动扫描。

教程：https://www.cnblogs.com/javazhiyin/p/11175068.html

@Import

@Target(ElementType.TYPE)

org.springframework.context.annotation.Import
  1. @Import注解用于在一个配置类中引入其他配置类，从而实现配置的模块化和重用。通过@Import注解，可以将其他配置类中定义的 bean 导入到当前的配置中，从而实现更好的组织和管理。
  2. @Import的三种用法 1）直接填class数组方式 2）ImportSelector方式【重点】 3）ImportBeanDefinitionRegistrar方式

@RequestMapping

@Target({ElementType.METHOD, ElementType.TYPE})

org.springframework.web.bind

.annotation.RequestMapping

要配置 Web 请求的映射，就需要你用上 @RequestMapping 注解。

注解可以在控制器类的级别和/或其中的方法的级别上使用。

可以将多个请求映射到一个方法上去，只需要添加一个带有请求路径值列表

@RequestParam 注解配合 @RequestMapping 一起使用，可以将请求的参数同处理方法的参数绑定在一起。

@RequestMapping 注解能够处理 HTTP 请求的方法, 比如 GET, PUT, POST, DELETE 以及 PATCH

@RequestMapping参数

  1. value:指定请求的实际地址，像/action/info这样的。
  2. method：指定请求的method类型， GET、POST、PUT、DELETE等。
  3. produces：它的作用是指定返回内容的类型，只有当request请求头中Accept属性包含该produces指定的类型才能返回数据成功。
  4. consumes：它的作用是指定request请求提交的内容类型(Content-Type)
  5. params：指定request请求地址中必须包含某些参数值，才让该方法处理。

教程：超详细 Spring @RequestMapping 注解使用技巧 - 掘金

@GetMapping

@Target({ElementType.METHOD, ElementType.TYPE})

@RequestMapping衍生注解

@PostMapping

@Target({ElementType.METHOD, ElementType.TYPE})

@RequestMapping衍生注解

@DeleteMapping

@Target({ElementType.METHOD, ElementType.TYPE})

@RequestMapping衍生注解

@PutMapping

@Target({ElementType.METHOD, ElementType.TYPE})

@RequestMapping衍生注解

@PatchMapping

@Target({ElementType.METHOD, ElementType.TYPE})

@RequestMapping衍生注解

@RequestParam

@Target({ElementType.PARAMETER})

org.springframework.web.bind

.annotation.RequestParam
  1. 简单一点说作用就是把请求中的指定名称的参数传递给控制器中的形参赋值
  2. @RequestParam注解的value属性值没有对应上jsp中name值则会直接报400错误，因为required属性默认为true，如果加上required=false，没对应上则不会报错，而是获取值为null
  3. 标注在接口的方法参数上，被标注的参数的值来源于request.getParameter或request.getParameterValues。

教程：@RequestParam用法及原理，你未必真知道-腾讯云开发者社区-腾讯云

@PathParam

@Target({

ElementType.PARAMETER,

ElementType.METHOD,

ElementType.FIELD

})

javax.ws.rs.PathParam

jboss包下面的一个实现

教程：理解RESTful中的@PathParam和@QueryParam注解-百度开发者中心

@QueryParam

@Target({

ElementType.PARAMETER,

ElementType.METHOD,

ElementType.FIELD

})

javax.ws.rs.QueryParam

jboss包下面的一个实现

教程：理解RESTful中的@PathParam和@QueryParam注解-百度开发者中心

@PathVariable

@Target({ElementType.PARAMETER})

org.springframework.web.bind

.annotation.PathVariable

用于restful参数绑定，和@RequestMapping注解及其衍生类进行配合使用

教程：Spring @PathVariable Annotation | Baeldung

@ResponseBody

@Target({

ElementType.TYPE,

ElementType.METHOD

})

org.springframework.web.bind

.annotation.ResponseBody

@ResponseBody用于请求处理方法上，表示方法返回的结果直接写入 HTTP 响应正文（ResponseBody）中，而不是将视图名称解析为视图的内容。该注解通常用于返回 JSON、XML 或二进制数据，而不是 HTML 视图。

教程：@ResponseBody注解-阿里云开发者社区

@RequestHeader

@Target({ElementType.PARAMETER})

org.springframework.web.bind

.annotation.RequestHeader

在Spring MVC中，@RequestHeader注解用于获取HTTP请求头的值。在处理请求时，可能需要访问请求头中的某些信息，如客户端的User-Agent、Content-Type等。使用@RequestHeader注解，我们可以轻松地访问这些信息，以便在Controller中使用。

教程：SpringMVC @RequestHeader注解-腾讯云开发者社区-腾讯云

@CookieValue

@Target({ElementType.PARAMETER})

org.springframework.web.bind.annotation.CookieValue

将cookie参数映射到控制器方法参数中

教程：饼干探秘：深入Spring MVC中获取Cookie数据的技术解析_springframework cookie-优快云博客

@RequestBody

@Target({ElementType.PARAMETER})

org.springframework.web.bind.annotation.RequestBody

@RequestBody注解是Spring框架中常用的注解之一，用于将HTTP请求的请求体中的数据绑定到一个Java对象上。通过使用@RequestBody注解，可以将请求体中的JSON/XML等格式的数据转换为Java对象，并传递给Controller中的方法进行处理。

教程：@RequestBody注解的作用和示例 – 编程技术之美-IT之美

【SpringBoot教程】RequestBody对象数组提交接口开发实战-腾讯云开发者社区-腾讯云

@Scope

@Target({ElementType.TYPE, ElementType.METHOD})

org.springframework.context

.annotation.Scope

用来表示Spring中Bean的作用域范围， 该注解只能写在类上或者方法上。

@Scope作用于范围：singleton(默认)、prototype、request、session

作用在类上，搭配@Component、@Service注解使用

作用于方法上，搭配@Bean使用

教程：【Spring注解必知必会】全面了解@Scope - 掘金

@Transactional

@Target({ElementType.METHOD, ElementType.TYPE})

org.springframework.transaction.annotation.Transactional

事务注解

iranw
关注
@Web注解快速配置
架构大师笔记
07-31 1万+
以注解的方式配置servlet @WebServlet(name=”servletName”, urlPatterns=”/test.do”) 以注解的方式配置filter @WebFilter(filterName=”yourFilterName”, servletNames=”yourServletName”, urlPatterns=”/index.html”) 关于过滤器使用注解配...
深入理解Web注解：解析常用注解及其应用场景
2301_76546533的博客
12-06 1162
浏览器是用来访问和显示网页的软件，用户可以通过浏览器输入URL来请求特定的网页，并且点击超链接以跳转到其他网页。动态网页可以根据用户的请求或其他条件生成不同的内容，而交互式Web应用程序能够与用户进行实时的交互和数据交换，从而提供更加丰富和便捷的功能。动态网页可以根据用户的请求和其他条件生成不同的内容，通常使用服务器端脚本语言（如PHP、Python和Java）和数据库来实现。它已经成为我们日常生活和工作中不可或缺的一部分，不断演进和创新，为我们提供丰富的在线资源和服务。
WEB注解
小汤圆
02-18 228
WEB注解
web项目中的注解介绍
积极向上的老王诩
07-11 779
@JoinColumn @OneToOne 一对一 现假设有Person表和Address表，是一对一的关系，在Person中有一个指向Address表主键的字段addressID，所以主控方一定是Person，所谓主控方就是能改变关联关系的一方，Person只要改变addressID就改变了关联关系，所以Person是主控方，所以@JoinColumn写在Person类中 @OneT...
Web基础（十）----注解
csdn_kenneth的博客
12-28 557
一、什么是注解，注解作用 注解就是符合一定格式的语法 @xxxx 注解作用： 注释：在阅读程序时清楚----给程序员看的 注解：给jvm看的，给机器看的。jvm读到注解的时候，会完成一定的功能。 注解在目前而言最主流的应用：代替配置文件 关于配置文件与注解开发的优缺点： 注解优点：开发效率高 成本低   注解缺点：耦合性大 并且不利于后期维护 案例： 我们创建一个web工程，d
SpringBoot & SpringCloud 注解 & 依赖
异侠
04-23 832
文章目录@SpringBootApplication@ResponseBody@RestController@RestController@RequestMapping("/hello") @SpringBootApplication 应用的主程序类 package com.abc; /** * @author 异侠 2021/4/23 */ import org.springframework.boot.SpringApplication; import org.springframewor
Spring中常用注解的详细介绍
10-20
本文将深入探讨Spring中常用的注解，包括它们的功能、使用场景以及如何配合配置文件使用。 首先，让我们来看看配置文件中的关键注解配置。在XML配置文件中，`<context:component-scan>`标签用于扫描指定的包（如`...
spring springMVC中常用注解解析
08-27
下面我们将详细讲解一些常用的注解。 1. **@Configuration 和 @ComponentScan** - `@Configuration`：这是一个核心注解，用于标记一个类作为Spring配置元数据的源，类似于XML配置文件中的`<beans>`元素。 - `@...
Javaweb的常用注解使用
m0_64462261的博客
05-23 1086
RestController: 用于标识REST风格的控制器，它组合了@Controller和@ResponseBody。用了该注解就不能在使用@Test注解了。@Autowired: 用于自动注入依赖的组件，可以用于字段、构造器、设置方法和普通方法。@Resource: 用于字段或构造器参数，可以指定名称，用于解决同名Bean的注入问题。@Qualifier: 与@Autowired一起使用，用于解决同名Bean的注入问题。@Controller: 用于标识数据请求层(请求层)，处理HTTP请求。
基于spring boot搭建的web基础框架包含了web开发中常用的功能如缓存redis日志事务JPAJN.zip
最新发布
12-07
在这一框架中，通常会集成许多开发中常用的功能模块，比如缓存、日志、事务处理以及对Java持久化API（JPA）的支持。 缓存是Web应用中用于临时存储频繁访问数据的组件，以减少数据库的访问次数和提高数据检索速度。...
java web开发（注解）
嵌入式-老费，一个分享专业嵌入式知识的blog
09-30 534
【 声明：版权所有，欢迎转载，请勿用于商业用途。 联系信箱：feixiaoxing @163.com】 注解也是蛮有意思的。个人来看，它更多是一种偷懒的处理方法。一种常见的场景是这样的，如果我们希望对某一种类型的数据来做判断，那么就是在每个函数开始的位置添加各种各样的判断语句。如果数据比较少的话，尚可接受；但是数据一多，整个代码就显得非常臃肿。 下面，我们就通过一个简单的例子，看看注解如何使用，
Spring Web 常用注解解析
leo187的博客
08-07 1525
@RequestMapping、@RequestBody、@PathVariable、@RequestParam、@ResponseBody、@Controller、@RestController、@ModelAttribute、@CrossOrigin 等注解讲解
048-Java注解（JAVA SE 基础完结）
陈塘关哪吒
02-05 323
目录 注解与注释 定义 自定义注解 在程序使用(解析)注解 感谢关注 注解与注释 注解：说明程序的，给计算机看的。 注释：用文字描述程序的，给程序员看的。 定义 注解（Annotation），也叫元数据。一种代码级别的说明。 它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说...
Web常见注解
lsj614的博客
01-02 1629
总而言之，恰当的使用注解可以提高代码的可读性和维护性，同时也可以减少重复的工作。
Java web 开发中常见注解
qq_44431331的博客
05-13 1349
适用场景：在使用AOP开发时，为了实现特定的通知功能，可以使用@Before、@AfterReturning、@AfterThrowing、@Around等注解进行定义。适用场景：在使用Spring MVC进行Web开发时，需要使用@Controller注解来标记Controller类，让Spring识别。适用场景：在使用AOP开发时，需要使用@Pointcut注解定义切入点表达式，以便后面的@Before、@After等注解可重用。
web的注解应用
Glowing_cat的博客
12-08 1685
Web注解（Web Annotations）是一种用于Java Web应用程序中的元数据标记技术，可以在代码中添加注解简化开发过程和提供额外的功能，还可以应用于Servlet、过滤器、监听器等组件上，实现请求和响应的处理。
Java web开发注解 （从servlet到spring）
yuluo的博客
05-17 1383
1，Java servlet jakarta.servlet.annotation.webServlet @WebServlet: 标注此类是一个servelt name：用来指定servlet的名字，等同于web.xml中的 urlPatterns (value)：是一个数组，用来指定servlet的映射路径，相当于web.xml中的 loadOnStartup：用来指定在服务器启动阶段是否加载该servlet，等同于 initParams： 用来指定servlet的初始化参数 当注解的属性名是va
JavaWeb——注解
Jorocco的博客
04-09 4806
1、类加载器 什么是类加载器，作用是什么？ 类加载器就加载字节码文件(.class) 2．类加载器的种类 类加载器有三种，不同类加载器加载不同的 1）BootStrap：引导类加载器：加载都是最基础的文件 2）ExtClassLoader：扩展类加载器：加载都是基础的文件 3）AppClassLoader：应用类加载器：三方jar包和自己编写java文件 3、注解 1...
spring常用的一些注解以及注解注入总结
热门推荐
AILAN_的专栏
08-15 3万+
常用的spring注解有如下几种： @Controller @Service @Autowired @RequestMapping @RequestParam @ModelAttribute @Cacheable @CacheFlush @Resource @PostConstruct @PreDestroy @Repository @Component （不推荐使用
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值