Spring Boot常用注解有哪些？一文搞懂@Controller等核心注解用法_Java

@controller

解释：

用于标记一个类是 spring mvc 中的控制器。
控制器负责处理 http 请求并返回响应。
它是 spring web 应用程序中处理用户请求的核心组件。

@requestmapping

解释：

用于将 http 请求映射到控制器的处理方法上。
它可以应用在类级别和方法级别。
在类级别上，它定义了一个基本的请求路径前缀，在方法级别上，它定义了具体的请求路径和请求方法（如 get、post 等）。

@getmapping、@postmapping等组合注解

解释：

这些是@requestmapping的变体。
@getmapping用于处理 http get 请求，@postmapping用于处理 http post 请求，还有@putmapping（处理 put 请求）、@deletemapping（处理 delete 请求）等。
它们使代码更加简洁，提高了可读性。

@responsebody

解释：

用于将控制器方法返回的对象转换为 http 响应体。
通常用于返回 json 数据等非视图相关的内容。
当一个方法被标注了@responsebody，spring 会使用合适的消息转换器（如 jackson）将返回对象转换为 json 或其他格式发送给客户端。

   @controller
   @requestmapping("/api/user")
   public class userapicontroller {
       @getmapping("/{id}")
       @responsebody
       public user getuserbyid(@pathvariable("id") long id) {
           // 根据id查询用户
           user user = userservice.getuserbyid(id);
           return user;
       }
   }

这个方法返回一个user对象，spring 会将其转换为 json 格式（假设配置了 jackson）发送给客户端。

@pathvariable

解释：

用于从请求路径中获取参数值。
当请求路径中有变量部分时，如/user/{id}，可以使用@pathvariable来获取{id}的值并将其作为方法参数。

   @controller
   @requestmapping("/product")
   public class productcontroller {
       @getmapping("/{productid}")
       public string getproduct(@pathvariable("productid") long id) {
           // 根据产品id查询产品信息
           product product = productservice.getproductbyid(id);
           // 处理产品信息并返回视图
           return "productdetails";
       }
   }

@requestparam

解释：

用于获取请求参数的值，通常用于处理查询字符串参数或表单参数。
它可以指定参数的名称、是否必需以及默认值等。

   @controller
   @requestmapping("/search")
   public class searchcontroller {
       @getmapping
       public string search(@requestparam("keyword") string keyword) {
           // 根据关键字进行搜索
           list<product> products = productservice.searchproducts(keyword);
           // 处理搜索结果并返回视图
           return "searchresults";
       }
   }

上述代码中，search方法获取名为keyword的请求参数，用于执行产品搜索。

如果请求中没有keyword参数，会抛出异常，除非设置为非必需参数。

@autowired

解释：

用于自动装配 spring 管理的 bean。
它可以应用在字段、构造函数或方法上。
spring 会根据类型自动查找并注入匹配的 bean 实例。

@controller
public class ordercontroller {
    @autowired
    private orderservice orderservice;
    // 处理订单相关的方法
}

@service

解释：

用于标注业务逻辑层（service 层）的类。
它是一个构造型（stereotype）注解，将一个类标记为 spring 容器中的一个 bean，主要用于实现业务逻辑。
被标注的类可以被其他组件（如控制器）通过@autowired等方式进行注入和使用。

@service
public class userservice {
    public user getuserbyid(long id) {
        // 从数据库或其他数据源获取用户的逻辑
        return userrepository.findbyid(id).orelse(null);
    }
}

这里userservice类提供了获取用户的业务逻辑，并且可以被注入到其他组件中使用。

@repository

解释：

用于标注数据访问层（dao 层）的类，它也是一个构造型注解。
通常用于对数据库或其他持久化存储进行操作的类。
它的主要作用是将数据访问层的类标记为 spring 容器中的 bean，并且可以处理一些与数据访问相关的异常转换（如将原生的持久化异常转换为 spring 的dataaccessexception体系）。

   @repository
   public class userrepositoryimpl implements userrepository {
       @autowired
       private jdbctemplate jdbctemplate;
       public user findbyid(long id) {
           // 使用jdbctemplate从数据库查询用户的逻辑
           string sql = "select * from users where id =?";
           user user = jdbctemplate.queryforobject(sql, new object[]{id}, new userrowmapper());
           return user;
       }
   }

这个userrepositoryimpl类实现了数据访问的逻辑，通过jdbctemplate从数据库中查询用户信息，并且可以被userservice等上层组件注入和使用。

@componentscan

解释：

用于指定 spring 应该扫描哪些包来查找组件（如@controller、@service、@repository等标注的类）。
它通常在配置类（用@configuration标注）中使用，可以自动发现和注册 bean 到 spring 容器中，减少了手动配置 bean 的工作量。

   @configuration
   @componentscan("com.example.myapp")
   public class appconfig {
       // 可以在这里添加其他配置方法
   }

上述配置会扫描com.example.myapp及其子包下的所有组件，并将它们注册到 spring 容器中。

@configuration

解释：

用于标记一个类为 spring 的配置类。
在这个类中可以定义 bean、导入其他配置类、设置属性源等。
它可以替代传统的 xml 配置文件，通过 java 代码的方式来配置 spring 容器。

   @configuration
   public class databaseconfig {
       @bean
       public datasource datasource() {
           // 配置数据源的逻辑，如返回一个druiddatasource实例
           druiddatasource datasource = new druiddatasource();
           datasource.seturl("jdbc:mysql://localhost:3306/mydb");
           datasource.setusername("root");
           datasource.setpassword("password");
           return datasource;
       }
   }

这个databaseconfig类是一个配置类，其中datasource方法定义了一个datasource类型的 bean，spring

会将这个方法返回的对象注册到容器中作为一个 bean。

@qualifier

解释：

当有多个相同类型的 bean 存在于 spring 容器中时，@qualifier用于指定要注入的具体 bean。
它与@autowired一起使用，通过名称来区分不同的 bean。

@configuration
public class appconfig {
    @bean("datasource1")
    public datasource datasource1() {
        // 配置第一个数据源的逻辑
        return new druiddatasource();
    }
    @bean("datasource2")
    public datasource datasource2() {
        // 配置第二个数据源的逻辑
        return new hikaridatasource();
    }
    @service
    public class userservice {
        @autowired
        @qualifier("datasource1")
        private datasource datasource;
        // 使用指定的数据源进行用户相关的业务逻辑
    }
}

在userservice中，通过@qualifier(“datasource1”)指定要注入的是名为datasource1的数据源。

@exceptionhandler

解释：

用于在控制器类中统一处理异常。
当控制器方法抛出指定类型的异常时，被@exceptionhandler标注的方法会被调用，用于返回合适的响应给客户端，如返回错误信息页面或者错误 json 数据等。

   @controller
   public class mycontroller {
       @requestmapping("/operation")
       public string dooperation() {
           // 可能抛出异常的操作
           throw new mybusinessexception("业务操作出错");
       }
       @exceptionhandler(mybusinessexception.class)
       public string handlebusinessexception(mybusinessexception ex) {
           // 处理业务异常，如记录日志、返回错误页面等
           return "errorpage";
       }
   }

当dooperation方法抛出mybusinessexception时，handlebusinessexception方法会被调用，返回errorpage视图给客户端。

@initbinder

解释：

用于在控制器中自定义数据绑定。
可以用于注册自定义的属性编辑器（property editor）或者格式化器（formatter），对请求参数进行转换和格式化，以便正确地绑定到控制器方法的参数上。

   @controller
   public class mycontroller {
       @initbinder
       public void initbinder(webdatabinder binder) {
           binder.registercustomeditor(date.class, new customdateeditor(new simpledateformat("yyyy - mm - dd"), true));
       }
       @requestmapping("/date")
       public string processdate(date date) {
           // 处理日期参数的逻辑
           return "success";
       }
   }

这里initbinder方法注册了一个自定义的日期编辑器，用于将请求中的日期字符串按照yyyy - mm - dd的格式转换为date类型，以便正确地绑定到processdate方法的date参数上。

@before、@after、@around等 aop 通知注解

解释：

@before：如前面例子所示，用于在目标方法执行之前执行切面中的代码。可以用于权限检查、参数验证、日志记录等操作。
@after：用于在目标方法执行之后执行切面中的代码，无论目标方法是否抛出异常。可以用于资源清理、记录方法执行后的状态等。
@around：是功能最强大的 aop 通知类型。它可以在目标方法执行前后都进行操作，并且可以控制目标方法是否真正执行。可以用于实现复杂的事务管理、性能监控等功能。

//after示例：
@aspect
@component
public class resourcecleanupaspect {
    @after("execution(* com.example.dao..*.*(..))")
    public void cleanupafter(joinpoint joinpoint) {
        system.out.println("方法执行后进行资源清理");
        // 可以在这里进行数据库连接关闭、文件流关闭等资源清理操作
    }
}

//@around
@aspect
@component
public class transactionaspect {
    @around("execution(* com.example.service..*.*(..))")
    public object managetransaction(proceedingjoinpoint pjp) throws throwable {
        try {
            // 开启事务
            system.out.println("开启事务");
            object result = pjp.proceed();
            // 提交事务
            system.out.println("提交事务");
            return result;
        } catch (exception e) {
            // 回滚事务
            system.out.println("回滚事务");
            throw e;
        }
    }
}

在这个transactionaspect的@around示例中，在目标服务方法执行前开启事务，方法执行后根据情况提交或回滚事务，实现了事务管理的 aop 切面。

@profile

解释：

用于根据不同的环境配置（如开发环境、测试环境、生产环境）来加载不同的 bean 或者配置。
可以将 bean 或者配置类标记为特定的环境配置文件相关。
在运行时，可以通过设置活动的环境配置文件（如通过spring.profiles.active属性）来决定启用哪些被@profile标注的组件。

@configuration
@profile("dev")
public class devdatabaseconfig {
    @bean
    public datasource datasource() {
        // 配置开发环境下的数据源，如使用本地数据库
        return new druiddatasource();
    }
}

@transactional

解释：

用于在方法或类级别上声明事务。
当应用在方法上时，该方法的执行会被包含在一个事务中；当应用在类级别上时，类中的所有公共方法都会被包含在事务中。
可以设置事务的属性，如传播行为（propagation）、隔离级别（isolation）、超时时间（timeout）和是否只读（read - only）等。

@service
public class accountservice {
    @transactional(propagation = propagation.required, isolation = isolation.default)
    public void transfermoney(account from, account to, bigdecimal amount) {
        from.setbalance(from.getbalance().subtract(amount));
        to.setbalance(to.getbalance().add(amount));
        accountrepository.save(from);
        accountrepository.save(to);
    }
}

@valid和@validated

解释：

@valid：这是 java bean validation（jsr 303）规范中的注解，用于标记一个方法参数或返回值应该被验证。它通常和验证注解（如@notnull、@size等）一起使用，用于对请求参数进行验证。spring mvc 会自动检测被@valid标注的参数，并触发验证逻辑。
@validated：这是 spring 提供的注解，它是@valid的增强版。除了支持 jsr 303 验证外，还支持 spring 特有的验证分组功能。可以通过定义不同的验证分组来对同一对象在不同场景下进行有针对性的验证。

@controller
public class usercontroller {
    @requestmapping("/user")
    public string adduser(@valid user user, bindingresult bindingresult) {
        if (bindingresult.haserrors()) {
            return "userform";
        }
        userservice.adduser(user);
        return "success";
    }
}

这里@valid用于验证user对象的参数。如果验证不通过，bindingresult会包含错误信息，然后可以根据这些信息返回错误页面。

@service
@validated
public class userservice {
    public void adduser(@validated(addusergroup.class) user user) {
        // 添加用户的逻辑
    }
}

假设定义了addusergroup验证分组，@validated(addusergroup.class)用于按照这个分组的验证规则来验证user对象。

@value

解释：

用于注入外部配置的值，如属性文件中的配置项或者环境变量的值。
它可以直接注入基本数据类型（如string、int、boolean等）的值到 bean 的字段或者方法参数中。

@component
public class mycomponent {
    @value("${myapp.config.key}")
    private string configvalue;
    // 可以在方法中使用configvalue
}

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持代码网。

Spring Boot常用注解有哪些？一文搞懂@Controller等核心注解用法

2026年07月17日 • Java •我要评论