优秀的编程知识分享平台

网站首页 > 技术文章 正文

Spring&SpringBoot常用注解总结

nanyue 2025-07-28 19:27:37 技术文章 1 ℃

在Java开发领域,Spring和Spring Boot是两个极为重要的框架,它们极大地提高了开发效率,简化了开发流程。而注解作为这两个框架的核心特性之一,发挥着关键作用。以下将对Spring和Spring Boot中的常用注解进行详细总结。

一、Spring常用注解

(一)组件注解

  1. @Component 作用:这是一个通用的组件注解,用于将一个类标识为Spring容器中的一个组件。被该注解标注的类会被Spring自动扫描并注册到容器中。 示例
@Component
public class MyComponent {
    public void doSomething() {
        System.out.println("Doing something in MyComponent");
    }
}
  1. @Repository 作用:主要用于标注数据访问层的类,即DAO(Data Access Object)类。它除了具备@Component的功能外,还能将DAO类中抛出的异常自动转换为Spring的持久化异常体系。 示例
@Repository
public class UserDao {
    public void saveUser() {
        // 实现保存用户的逻辑
    }
}
  1. @Service 作用:通常用于标注业务逻辑层的类,也就是Service类。它同样是@Component的一种特殊形式,使代码的结构更加清晰,便于区分不同层次的组件。 示例
@Service
public class UserService {
    @Autowired
    private UserDao userDao;

    public void saveUserService() {
        userDao.saveUser();
    }
}
  1. @Controller 作用:用于标注控制器层的类,在Spring MVC中,被该注解标注的类负责处理HTTP请求。它也是@Component的特殊形式。 示例
@Controller
public class UserController {
    @Autowired
    private UserService userService;

    @RequestMapping("/saveUser")
    public String saveUser() {
        userService.saveUserService();
        return "success";
    }
}

(二)依赖注入注解

  1. @Autowired 作用:这是Spring中最常用的依赖注入注解,它可以对类成员变量、方法和构造函数进行标注,完成自动装配的工作。默认按照类型进行装配。 示例
@Service
public class AnotherService {
    @Autowired
    private MyComponent myComponent;

    public void useComponent() {
        myComponent.doSomething();
    }
}
  1. @Qualifier 作用:当有多个相同类型的Bean可供注入时,@Autowired无法确定具体注入哪个Bean,此时可以使用@Qualifier来指定要注入的Bean的名称。 示例
@Component("component1")
public class MyComponent1 {
    public void doSomething() {
        System.out.println("Doing something in MyComponent1");
    }
}

@Component("component2")
public class MyComponent2 {
    public void doSomething() {
        System.out.println("Doing something in MyComponent2");
    }
}

@Service
public class ServiceWithQualifier {
    @Autowired
    @Qualifier("component1")
    private MyComponent1 myComponent1;

    public void useComponent() {
        myComponent1.doSomething();
    }
}
  1. @Resource 作用:这是Java JSR - 250规范中的注解,也用于依赖注入。它默认按照名称进行装配,如果找不到与名称匹配的Bean,则按照类型进行装配。 示例
@Service
public class ServiceWithResource {
    @Resource(name = "component1")
    private MyComponent1 myComponent1;

    public void useComponent() {
        myComponent1.doSomething();
    }
}

(三)配置类注解

  1. @Configuration 作用:用于标注一个类为配置类,该类相当于传统的XML配置文件。在配置类中可以使用@Bean注解来定义Bean。 示例
@Configuration
public class AppConfig {
    @Bean
    public MyComponent myComponent() {
        return new MyComponent();
    }
}
  1. @Bean 作用:用于在配置类中定义一个Bean,方法的返回值会被注册到Spring容器中。 示例:见@Configuration的示例。

(四)AOP注解

  1. @Aspect 作用:用于标注一个类为切面类,该类中可以定义切点、通知等AOP相关的内容。 示例
@Aspect
@Component
public class MyAspect {
    @Before("execution(* com.example.service.*.*(..))")
    public void beforeAdvice() {
        System.out.println("Before method execution");
    }
}
  1. @Before 作用:这是一个前置通知注解,用于在目标方法执行之前执行指定的代码。 示例:见@Aspect的示例。
  2. @After 作用:后置通知注解,无论目标方法是否抛出异常,都会在目标方法执行之后执行指定的代码。
  3. @AfterReturning 作用:返回通知注解,在目标方法正常返回后执行指定的代码。
  4. @AfterThrowing 作用:异常通知注解,当目标方法抛出异常时执行指定的代码。
  5. @Around 作用:环绕通知注解,它可以在目标方法执行前后都进行增强处理,并且可以控制目标方法是否执行。

二、Spring Boot常用注解

(一)启动类注解

  1. @SpringBootApplication 作用:这是Spring Boot应用的核心注解,它是@Configuration、@EnableAutoConfiguration和@ComponentScan的组合注解。使用该注解可以快速启动一个Spring Boot应用。 示例
@SpringBootApplication
public class MySpringBootApp {
    public static void main(String[] args) {
        SpringApplication.run(MySpringBootApp.class, args);
    }
}

(二)配置属性注解

  1. @ConfigurationProperties 作用:用于将配置文件中的属性值绑定到一个Java类的属性上。可以方便地读取配置文件中的信息。 示例
@ConfigurationProperties(prefix = "my.config")
@Component
public class MyConfigProperties {
    private String property1;
    private int property2;

    // 省略getter和setter方法
}

在application.properties文件中可以这样配置:

my.config.property1=value1
my.config.property2=10

(三)Web相关注解

  1. @RestController 作用:这是@Controller和@ResponseBody的组合注解,用于创建RESTful风格的控制器,返回的数据会直接作为响应体返回给客户端。 示例
@RestController
@RequestMapping("/api")
public class RestfulController {
    @GetMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }
}
  1. @RequestMapping 作用:用于映射HTTP请求,将请求URL映射到具体的处理方法上。可以指定请求的方法(如GET、POST等)、请求的路径等。 示例:见@RestController的示例。
  2. @GetMapping、@PostMapping、@PutMapping、@DeleteMapping 作用:这些是@RequestMapping的特定方法的快捷注解,分别对应HTTP的GET、POST、PUT、DELETE请求方法。 示例:见@RestController的示例。

(四)测试注解

  1. @SpringBootTest 作用:用于在Spring Boot应用中进行集成测试,它会启动整个Spring应用上下文,以便对应用进行全面的测试。 示例
@SpringBootTest
class MySpringBootAppTest {
    @Test
    void contextLoads() {
        // 测试代码
    }
}

Spring和Spring Boot中的这些常用注解极大地简化了开发过程,提高了代码的可维护性和可扩展性。开发者熟练掌握这些注解的使用,能够更加高效地进行Java开发。

最近发表
标签列表