Spring使用(一)注解

news2024/11/25 5:28:57

Spring使用

资源

Spring 框架内部使用 Resource 接口作为所有资源的抽象和访问接口,在上一篇文章的示例代码中的配置文件是通过ClassPathResource 进行封装的,ClassPathResource 是 Resource 的一个特定类型的实现,代表的是位于 classpath 中的资源。

对不同来源的资源文件 Spring 都提供了相应的实现:文件(FileSystemResource )、ClassPath资源(ClassPathResource)、URL资源(UrlResource)、InputStream资源(InputStreamResource)、ByteArray资源(ByteArrayResource)等。

注解

spring mvc注解.png

宏观:

①Service

@Service 注解是用来声明服务层(Service Layer)组件,通常包含业务逻辑,作为数据访问层(Data Access Layer)和控制器(Controller Layer)之间的桥梁。

  • 它是一个立即加载的注解,这意味着当 Spring 应用程序启动时,Spring 容器就会创建标注了 @Service 的类的实例。
  • @Service 是一个特殊类型的 @Component 注解。它允许自动检测通过类路径扫描,为其创建 Bean 定义并注册到 Spring 容器中。
  • 它有助于区分 Spring 组件的表示层(Controller)、服务层(Service)和数据访问层(Repository)。

②Controller

用于标记一个类作为 Spring MVC 控制器组件。控制器负责处理由 DispatcherServlet 分发的来自浏览器或其他客户端的 HTTP 请求。这个注解会将类识别为一个 Bean,并注册到 Spring 应用上下文中。

  • 通常与 @RequestMapping 或其他基于 HTTP 方法的注解(@GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping)配合使用,以定义访问该控制器方法的 URL 模式和请求类型。
  • 允许通过依赖注入引入其他层级的服务或组件,比如服务层 (@Service) 或数据访问层 (@Repository)。
  • 与视图技术(如 Thymeleaf、JSP 等)协同工作,可以返回 String 类型的视图名,由视图解析器进一步处理。
  • 当使用 Spring Boot 和 RESTful Web 服务时,通常会结合 @RestController 注解来使用,它是 @Controller@ResponseBody 的组合体,这意味着控制器的所有响应默认都会转换成 JSON 或 XML 格式返回给客户端。
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.ui.Model;

@Controller
public class MyController {

    @RequestMapping("/greet")
    public String greet(Model model) {
        model.addAttribute("message", "Hello, World!");
        return "greeting"; // 返回视图名称,通常是一个 HTML 页面
    }
}

③Repository

用于标识持久层组件(如DAO组件)的特殊化 @Component 注解。当你在类上使用 @Repository 注解时,它会告知 Spring 容器该类是一个 Bean,并且用于封装数据访问异常,将底层数据访问技术抛出的异常转换为 Spring 的 DataAccessException

// 告诉Spring,让Spring创建一个名字叫“userDao”的UserDaoImpl实例。
@Repository(value="userDao")
public class UserDaoImpl extends BaseDaoImpl<User> {
………
}

// 注入userDao,从数据库中根据用户Id取出指定用户时需要用到
@Resource(name = "userDao")
private BaseDao<User> userDao;

④Configuration

@Configuration 是表明某个类是用来作为 bean 定义的源的。被 @Configuration 注解的类通常包含了一个或多个标记有 @Bean 注解的方法。Spring 容器会在运行时自动调用这些方法,将返回对象注册为容器中的 bean。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {

    @Bean
    public MyService myService() {
        return new MyServiceImpl();
    }
}
// AppConfig 类被标注为 @Configuration,这意味着它可以包含 bean 定义。myService 方法上的 @Bean 注解告诉 Spring,这个方法将返回一个对象,该对象需要被注册为应用程序上下文中的一个 bean。默认情况下,bean 的名称与方法名相同,但可以通过 @Bean 注解的 name 属性来自定义。

// 这种配置方式实现了代码的模块化,并且取代了传统的 XML 配置文件,使得配置更加清晰和类型安全

⑤Resource

  • @Resource 默认按照 by-name 自动装配,即根据 bean 的名称进行匹配;如果没有找到与名称匹配的 bean,则会退回到 by-type 自动装配(首先尝试依据属性名作为 bean 名称查找,如果失败则按类型装配)。而 @Autowired 默认按照 by-type 自动装配。
  • @Resource 所标注的自动装配过程是在 bean 属性设置完成之后、初始化方法(如 @PostConstruct 注解的方法)之前进行的,而 @Autowired 则是在构造器、字段、setter 方法或其他任意带有参数的方法上使用。
import javax.annotation.Resource;
@Component
public class MyComponent {
    // By name
    @Resource(name = "myBean")
    private MyBean myBeanByName;

    // By type (当存在多个相同类型的 bean 时,可能需要指定 name 来避免冲突)
    @Resource
    private MyBean myBeanByType;

    public void doSomething() {
        // 使用 myBeanByName 和 myBeanByType 完成一些操作...
    }
}
// @Resource 注解有两个重要的属性:name 和 type:
name: 指定要注入的 bean 的名称。
type: 指定要注入的 bean 的类型。
微观

① Async:将方法标注为异步执行

在一个普通的方法或者类中调用了由 @Async 注解标记的方法,那么当前线程会立即返回,而实际执行的过程会在另外的线程中进行,当前线程将继续执行自身的任务。

@Service
public class MyService {
  
  @Autowired
  private EmailService emailService;

  @Async
  public void sendEmails(List<String> recipients, String content) {

    for (String recipient : recipients) {
      emailService.sendEmail(recipient, content);
    }

    System.out.println("All emails sent!");
  }
}

②Autowired:自动装配依赖的 bean。

@Autowired 注解是 Spring Framework 中的一个依赖注入注解,它可以自动将容器中已经创建好的 bean 对象装配到需要他们的类或者方法中。默认先按byType进行匹配,如果发现找到多个bean,则又按照byName方式进行匹配,如果还有多个,则报出异常

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class MyComponent {

    private final Dependency dependency;

    // 构造器注入,如果容器中不存在Dependency类型的Bean,应用将无法启动
    @Autowired(required = true)
    public MyComponent(Dependency dependency) {
        this.dependency = dependency;
    }
    
    // 如果容器中不存在OptionalDependency类型的Bean,则dependency字段将为null,但应用依旧会启动
    @Autowired(required = false)
    private OptionalDependency optionalDependency;
}

③Bean:声明一个需要被 Spring 管理的 bean

@Configuration // 添加了 @Configuration 注解来标识这是一个配置类,因此 Spring 容器在扫描时会识别并加载该类。
public class MyConfiguration {
  @Bean
  public UserDao userDao() {
    return new JdbcUserDao(dataSource());
  }
  @@Bean(“myBean”) // 这样可以在装配其他依赖项时方便地引用该 bean 对象。
  public DataSource dataSource() {
    // 创建并配置数据源对象
    return new HikariDataSource(config);
  }
}

在上面的代码中,我们定义了一个配置类 MyConfiguration,并在其中定义了两个 bean 对象:userDao() 和 dataSource()。其中 userDao() 方法返回 JdbcUserDao 对象,而 dataSource() 方法返回一个 Hikari 数据源对象。这两个方法都标记了 @Bean 注解,这意味着它们会被 Spring 容器扫描到并将创建的对象注册到容器中。

④Cacheable:增加缓存支持

@Cacheable 是 Spring Framework 中的一个注解,用于实现方法级别的缓存。使用 @Cacheable 注解的方法在调用时,将会检查缓存中是否存在与该方法所需参数相对应的缓存项。如果存在,则直接返回缓存结果,不再执行被注解的方法;如果不存在,则执行该方法,并将方法的返回结果添加到缓存中。

@Service
public class UserService {

  private final UserMapper userMapper;

  public UserService(UserMapper userMapper) {
    this.userMapper = userMapper;
  }

  @Cacheable(value = "users", key = "#userId")
  public User getUserById(int userId) {
    return userMapper.getUserById(userId);
  }

}

⑤ Conditional

Conditional用于根据特定条件动态决定是否创建某个 Bean 实例,Spring 还提供了一些预定义的条件注解,如 @Profile、@ConditionalOnMissingClass、@ConditionalOnProperty 等,它们可以方便地满足一些常见的判断场景,减少了编写自定义条件类的工作量。

@Configuration
public class MyConfiguration {
  @Bean
  @Conditional(MyCondition.class)
  public MyBean myBean() {
    return new MyBean();
  }
}

public class MyCondition implements Condition {
  @Override
  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
    // TODO: 自定义条件判断逻辑
    return true; // 当结果为 true 时,表示条件成立,按照要求创建 Bean;否则,则不会创建这个 Bean。
  }
}
使用 @Profile 注解可以确保只有相关的 beans 在特定的环境配置下被创建,这样可以避免在不适合的环境中运行可能引起冲突或异常的 beans,并有助于维护清晰的环境特定配置。
@Profile("development")
@Profile("production")

根据设置系统属性: -Dspring.profiles.active=development
或者使用环境变量设置 SPRING_PROFILES_ACTIVE=development等来切换profile

⑥ConstructorBinding

用于表示在使用基于构造器的依赖注入时,应该将配置属性绑定到构造器参数上

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.ConstructorBinding;

@ConstructorBinding
@ConfigurationProperties(prefix = "app") //指定哪个前缀的配置属性应被绑定到该类的字段上,Spring Boot 将会查找 app.name 和 app.threadPoolSize 配置项,并通过构造器自动注入相应的值。
public class AppConfigProperties {

    private final String name;
    private final int threadPoolSize;

    public AppConfigProperties(String name, int threadPoolSize) {
        this.name = name;
        this.threadPoolSize = threadPoolSize;
    }

    // Getters for the fields
    public String getName() {
        return name;
    }

    public int getThreadPoolSize() {
        return threadPoolSize;
    }
}

⑦ControllerAdvice

@ControllerAdvice 是 Spring MVC 框架中的注解,用于定义一个全局性的异常处理器类。可以对 Controller 层面和全局异常进行统一的处理。

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler({NullPointerException.class, IllegalArgumentException.class}) //当捕获到空指针异常或者非法参数异常时,会执行这个方法,将异常信息添加到 request 中,并返回 “error” 视图。
    public String handleException(Exception e, HttpServletRequest request) {
        request.setAttribute("error", e);
        return "error";
    }
}

⑧CrossOrigin

同源策略阻止一个域下的文档或脚本与另一个域下的资源进行交互。这有助于保护用户免受恶意网站的攻击,但也限制了合法的跨源请求。

例如,如果你的页面在 https://www.example.com 上运行,而尝试通过 AJAX 请求从 https://api.another-site.com 获取数据,这将被默认视为跨域请求,并可能遭到浏览器的阻止,除非目标服务器明确允许来自原始域的请求。
@RestController
@RequestMapping("/api")
public class ApiController {

    @CrossOrigin(origins = "http://localhost:8080")
    @GetMapping("/users/{id}")
    public User getUserById(@PathVariable Long id) {
        // ...
    }
}

⑨EnableAsync

在处理一些 IO 密集型操作时,非常有用

@Configuration
@EnableAsync // @EnableAsync 注解需要与异步方法搭配使用,异步方法需要用 @Async 标记。
public class AppConfig {

    @Bean
    public Executor taskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(10);
        executor.setMaxPoolSize(20);
        executor.setQueueCapacity(30);
        executor.initialize();
        return executor;
    }
}

⑩RequestMapping

@RequestMapping 的专门化版本提供了更简洁的语法。这些包括 @GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping。每个都对应于一个 HTTP 方法,使得代码更加简洁易读。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@RequestMapping("/api")
public class MyController {

    @GetMapping("/hello") // 等同于 @RequestMapping(value = "/hello", method = GET)
    @ResponseBody
    public String helloWorld() {
        return "Hello, World!";
    }

    @PostMapping("/submit") // 等同于 @RequestMapping(value = "/submit", method = POST)
    @ResponseBody
    public String submitForm() {
        // 方法实现
        return "Form submitted";
    }
}

其他

①lazy

@Lazy 是 Spring 框架中的注解之一,它用于控制 Bean 的实例化时间。通过在容器中标记一个 Bean 为 @Lazy,可以让 Spring 容器在第一次使用这个 Bean 时再进行实例化。相对应的,如果不加 @Lazy 注解,则默认情况下 Spring 容器会在启动时就实例化该 Bean。

@Service
@Lazy // 使用 @Lazy 注解,Spring 容器将在第一次使用 UserService 的实例时才进行实例化而不是在启动时就实例化
public class UserService {
    // ...
}

②Import

允许我们在一个配置类中引入其他配置类或普通的 Java 类

@Configuration
@Import({DataSourceConfig.class, RedisConfig.class, ServiceUtils.class})
public class AppConfig {
    // ...
}
// 在创建 Spring ApplicationContext 时,这三个配置类都会被加载并注册为 Spring 的 bean。
// 可以在 AppConfig 中使用 ServiceUtils 类中的方法或属性

③元注解

  • @Target:指定注解可以应用于 Java 的哪些元素(如类、方法、字段等)。
  • @Retention:指定注解在什么级别可用(源码、类文件或运行时)。
  • @Documented:指定注解是否应该被 javadoc 工具记录。
  • @Inherited:指定注解是否可以被子类继承。
  • @Component:Spring 特有的元注解,用于声明一个类是 Spring 组件。其它注解如 @Service, @Repository, @Controller 都是用 @Component 注解的例子。

④Valid

在控制器方法的参数列表中使用 @Valid ( @NotNull、@Min、@Max、@Size、@Email…)注解来实现请求参数的校验。

@RestController
@RequestMapping("/users")
public class UserController {
    @PostMapping
    public User createUser(@Valid @RequestBody User user) {
        // 保存用户信息到数据库
    }

    // ...
}

// 校验的规则通常定义在 User 类的属性上
public class User {
    @NotBlank
    private String username;

    @Pattern(regexp = "^[a-zA-Z0-9]+@[a-zA-Z0-9]+\\.[a-zA-Z]{2,}$", message = "Email 格式错误")
    private String email;
}
第三方
  1. @Data

    @Data注解是Lombok库的一部分,非Spring框架本身的一部分。当你在一个类上使用@Data注解,Lombok会自动生成以下代码:

    • 所有字段的getter方法
    • 所有非最终字段的setter方法
    • toString()方法
    • equals()hashCode()方法
    • 一个包含所有非静态、非瞬态字段的构造函数

    这大大减少了样板代码的数量,使得类的定义更加简洁

  2. @Mapper

    @Mapper注解是MyBatis框架的一部分,它主要用于标记一个接口作为数据库操作的映射接口。MyBatis通过这个接口关联XML配置文件或者注解中定义的数据库操作。

    @Mapper
    public interface UserMapper {
        User selectUserById(Long id);
    }
    
    // 在Spring Boot项目中,通常还会配合使用@MapperScan注解来指定需要扫描的@Mapper接口所在的包路径。
    @SpringBootApplication
    @MapperScan("com.example.project.mapper")
    public class Application {
        public static void main(String[] args) {
            SpringApplication.run(Application.class, args);
        }
    }
    

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1561670.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

Python创建三维空间立体方阵,根据赋予数值绘图赋色

代码如下&#xff1a; import matplotlib.pyplot as plt from mpl_toolkits.mplot3d.art3d import Poly3DCollection from matplotlib.colors import LinearSegmentedColormap, Normalize import numpy as npdef make_cube(matrix: np.ndarray)->None:fig plt.figure(figs…

vue项目视频播放ckplayer使用

ckplayer 官方网址&#xff0c;点击访问 1&#xff0c;打开网页后能看到这里&#xff0c;我现在使用的是最新 X3版手册 2&#xff0c;这个ckplayer不是npm 插件&#xff0c;要下载安装包解压到项目里面使用 安装包网址 通过gitee下载 3&#xff0c;解析安装包到项目中 publ…

leetcode 不同路径

62. 不同路径 问题描述 一个机器人位于一个 m x n 网格的左上角 &#xff08;起始点在下图中标记为 “Start” &#xff09;。 机器人每次只能向下或者向右移动一步。机器人试图达到网格的右下角&#xff08;在下图中标记为 “Finish” &#xff09;。 问总共有多少条不同的…

仿真黑科技EasyGo DeskSim 2022

DeskSim2022的FPGA支持多种solver的混合应用&#xff0c;对于每一种solver可以采用不同的仿真步长&#xff0c;以下图模型为例&#xff0c;模型运行在FPGA上&#xff0c;FPGA解算方式采用的是Power Electronic & FPGA Coder解算&#xff0c;其中电力电子电路部分采用了两种…

SD-WAN支持的多种线路类型

SD-WAN技术的崛起为企业网络带来了全新的可能性&#xff0c;尤其是在连接选项的多样性方面。通过SD-WAN方案&#xff0c;企业可以根据自身需求来选择最适合的连接类型&#xff0c;以实现性能优化和成本效益的平衡。下面&#xff0c;让我们深入了解SD-WAN所支持的各种线路类型。…

【御控物联】JavaScript JSON结构转换(12):对象To数组——键值互换属性重组

文章目录 一、JSON结构转换是什么&#xff1f;二、核心构件之转换映射三、案例之《JSON对象 To JSON数组》四、代码实现五、在线转换工具六、技术资料 一、JSON结构转换是什么&#xff1f; JSON结构转换指的是将一个JSON对象或JSON数组按照一定规则进行重组、筛选、映射或转换…

vue+elementUI实现表格组件的封装

效果图&#xff1a; 在父组件使用表格组件 <table-listref"table":stripe"true":loading"loading":set-table-h"slotProps.setMainCardBodyH":table-data"tableData":columns"columns.tableList || []":ra…

JAVAEE——多线程进阶,锁策略

文章目录 锁策略乐观锁和悲观锁乐观锁悲观锁两者的比较 读写锁重量级锁和轻量级锁重量级锁轻量级锁 自旋锁公平锁和非公平锁公平锁非公平锁 可重入锁和不可重入锁可重入锁不可重入锁 锁策略 乐观锁和悲观锁 乐观锁 什么是乐观锁呢&#xff1f;我们可以认为乐观锁比较自信&am…

MySQL 连接池的实现

池化技术 池化技术能够减少资源对象的创建次数&#xff0c;提高程序的响应性能&#xff0c;特别是在高并发下这种提高更明显。共同特征 对象创建时间长。对象创建需要大量资源。对象创建后可被重复使用。 数据库连接池 数据库连接池&#xff08;Connection pooling&#xff…

linux C:变量、运算符

linux C 文章目录 变量运算符 一、变量 [存储类型] 数据类型 标识符 值 标识符&#xff1a;由数字、字母、下划线组成的序列&#xff0c;不能以数字开头。 数据类型&#xff1a;基本数据类型构造类型 存储类型&#xff1a;auto static…

2.4_2 死锁的处理策略——预防死锁

2.4_2 死锁的处理策略——预防死锁 知识总览 #mermaid-svg-z0noPuUcH4CJsxb7 {font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:16px;fill:#333;}#mermaid-svg-z0noPuUcH4CJsxb7 .error-icon{fill:#552222;}#mermaid-svg-z0noPuUcH4CJsxb7 .error-t…

【BlossomRPC】接入注册中心

文章目录 NacosZookeeper自研配置中心 RPC项目 配置中心项目 网关项目 这是BlossomRPC项目的最后一篇文章了&#xff0c;接入完毕注册中心&#xff0c;一个完整的RPC框架就设计完成了。 对于项目对注册中心的整合&#xff0c;其实我们只需要再服务启动的时候将ip/port/servic…

商城业务-检索服务

文章目录 前言一、搭建页面环境1.1 静态界面搭建1.2 Nginx 动静分离1.3 Windows 上传文件1.4 引入 thymeleaf 依赖1.5 Nginx 反向代理1.4 Nginx 配置1.5 gateway 网关配置 二、调整页面跳转2.1 引入依赖2.2 页面跳转 三、检索查询参数模型分析抽取3.1 检索业务分析3.2 检索语句…

齿轮“红宝书”

​在齿轮行业&#xff0c;有两本书被广大从业者尊称为“红宝书”。这两部作品深入剖析了齿轮技术的精髓&#xff0c;为从业者提供了宝贵的指导和启示。它们犹如行业的明灯&#xff0c;照亮了齿轮制造的每一个角落&#xff0c;使得从业者在探索中不再迷茫。 这两本红宝书的内容…

遥感动态监测技术

很多人对动态监测和动态检测两个名词有疑惑。我们可以这样理解&#xff0c;动态监测是一个广义的名词&#xff0c;泛指数据预处理、变化信息发现与提取、变化信息挖掘与应用等&#xff0c;以对整个流程的叙述。动态检测是一个狭义的名词&#xff0c;主要指部分数据预处理、变化…

【御控物联】JavaScript JSON结构转换(7):数组To数组——键值互换属性重组

文章目录 一、JSON结构转换是什么&#xff1f;二、案例之《JSON数组 To JSON数组》三、代码实现四、在线转换工具五、技术资料 一、JSON结构转换是什么&#xff1f; JSON结构转换指的是将一个JSON对象或JSON数组按照一定规则进行重组、筛选、映射或转换&#xff0c;生成新的JS…

前端(三)React踩坑记录

一、引言 作者最近新的平台项目是需要用react的&#xff0c;和vue区别还是比较大的&#xff0c;这里记录下踩坑和使用经验。 二、环境 框架&#xff1a;antd 依赖&#xff1a; "dependencies": {"ant-design/icons": "^4.7.0","ant-desig…

Linux使用Docker部署RStudio Server结合内网穿透实现公网访问本地服务

文章目录 前言1. 安装RStudio Server2. 本地访问3. Linux 安装cpolar4. 配置RStudio server公网访问地址5. 公网远程访问RStudio6. 固定RStudio公网地址 前言 RStudio Server 使你能够在 Linux 服务器上运行你所熟悉和喜爱的 RStudio IDE&#xff0c;并通过 Web 浏览器进行访问…

卷积层+多个输入通道

卷积层多输入输出通道 在深度学习中&#xff0c;卷积神经网络&#xff08;CNN&#xff09;通常用于处理具有多个输入通道的数据。当输入数据具有多个通道&#xff08;例如彩色图像的RGB通道&#xff09;时&#xff0c;卷积操作可以同时在每个通道上进行&#xff0c;并将各通道的…