Spring boot常用注解详解和示例

前言:

本文主要介绍Spring boot中常用的注解,及其在项目开发中实际使用位置和示例。

一.注解对照表

注解 使用位置 作用
@Controller 类名上方 声明此类是一个SpringMVC Controller 对象
@RequestMapping 类或方法上 用在类上,表示所有响应请求的方法都是以该地址作为父路径
@ResponseBody 方法上 将Controller的方法返回的对象,通过适当的HttpMessageConverter转换为指定格式(Json/xml)后,写入到Response对象的body数据区。
@RestController 类名上 可代替@ResponseBody 和 @Controller合在一起的作用。但不能返回Jsp和HTML页面了
@RequestBody 方法参数前 常用来处理Content-Type: application/json, application/xml等,意味着HTTP消息是JSON,需转化为指定类型参数
@Service 类名上 声明是一个业务处理类(实现类非接口类)
@Repository 类名上 声明是一个数据库或其他NOSql访问类(实现类非接口类)
@Component 类名上 声明此类是Spring管理类,常用在无法用@Service、@Repository描述的Spring管理类上,相当于通用的注解
@Configuration 类名上 声明此类是一个配置类,常与@Bean配合使用
@Bean 方法名上 声明该方法返回结果是一个Spring容器管理的Bean,包含@PostConstruct和@PreDestory
@Qualifier 类名或属性上 为Bean指定名称,随后再通过名字引用Bean
@Autowired 属性或构造函数参数上 按byType自动注入
@Resource 类名上 默认按 byName自动注入
@Value 属性上 用于获取配置文件中的值
@PathVariable 方法参数前 将URL获取参数,映射到方法参数上

二.注解用法示例

1.@Controller

1.1 用在类名

@Controller
@RequestMapping("/api/v1/user")
public class UserController {}

2.@RequestMapping

2.1 用在类名

@Controller
@RequestMapping("/api/v1/user")
public class UserController {}

2.1 用在方法名

@RequestMapping(value = "getuser", method = RequestMethod.POST)
public List selectAll() {
    return userService.selectAll();
}

2.3 注解属性:

①. value, method;

value:指定请求的实际地址,指定的地址可以是URI Template 模式;

method:指定请求的method类型, GET、POST、PUT、DELETE等;

②.consumes,produces

consumes:指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;

produces: 指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;

③. params,headers

params: 指定request中必须包含某些参数值是,才让该方法处理。

headers: 指定request中必须包含某些指定的header值,才能让该方法处理请求。

3.@ResponseBody

3.1 用在方法名上

将返回对象输出到客户端,如果是字符串,直接输出;如果不是,则默认用Jackson序列化成Json字符串输出。

@ResponseBody
public User addUser(@RequestBody User user) {}

该注解将返回类型转换为指定格式,格式由程序控制,格式包括json、text、xml和其他。若转为Json,需要依赖Json解析Jar包。

4. @RestController

用于返回json、text、xml和其他等格式的数据,但不能返回Jsp和HTML页面。

@RestController
@RequestMapping("/api/v1/user")
public class UserController {}

5.@RequestBody

过使用HandlerAdapter,配置的HttpMessageConverters来将请求内容,转为指定的对象。Spring boot 默认用Jackson来处理反序列化工作。
下面示例是将请求Json参数,利用@RequestBody直接注入到EnterpriseEntity中,

@RequestMapping(value = "/enterprise/update", method = RequestMethod.PUT)
    public void updateEnterpriseInfo(@RequestBody EnterpriseEntity enterprise) {
    }

6.@Service

用在ServiceImpl实现类上,声明一个业务逻辑处理类。

@Service("userService")
public class UserServiceImpl implements UserService {}

7.@Repository

用在daoImpl实现类上,声明一个数据库访问类

@Repository
public class IocDao implements IIocDao{
    public void add(){
    }
}

8.@Component

如用在Mybatis的Mapper类上

@Component
@Mapper
public interface UserMapper {
    int deleteByPrimaryKey(Long userId);
}

9.@Configuration

@Configuration
@EnableCaching
public class RedisConfig {
    @Bean
    public CacheManager cacheManager(RedisTemplate redisTemplate) {

        RedisCacheManager cacheManager = new RedisCacheManager(redisTemplate);
        return cacheManager;
    }
}

10.@Bean

@Bean(name = "kafkaContainer")
public KafkaListenerContainerFactory<ConcurrentMessageListenerContainer<String, String>> kafkaListenerContainerFactory() {
    ConcurrentKafkaListenerContainerFactory<String, String> factory = new ConcurrentKafkaListenerContainerFactory<>();
    factory.setConsumerFactory(consumerFactory());
    factory.setConcurrency(1);
    factory.getContainerProperties().setPollTimeout(5000);
    return factory;
}

其中:

@PostConstruct Bean容器初始化后调用

@PreDestroy Bean容器销毁前调用

通过这连个注解,可以再Spring Bean创建和销毁前,调用我们自定义的方法。这样Spring Bean 整个生命周期,创建前、创建后、销毁前都可以指定调用的方法了,很方便。

public class CustomerService
{
    String message;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    @PostConstruct
    public void initIt() throws Exception {
        System.out.println("Init method after properties are set : " + message);
    }

    @PreDestroy
    public void cleanUp() throws Exception {
        System.out.println("Spring Container is destroy! Customer clean up");
    }

}

11.@Qualifier

先指定一个名字:@Qualifier(“primaryDataSource”)

@Autowired
@Qualifier("primaryDataSource")
private DataSource primaryDataSource;

再通过名字:@Qualifier(“primaryDataSource”)引用

@Bean(name = "primaryDataSource", initMethod = "init")
@Qualifier("primaryDataSource")
@ConfigurationProperties(prefix = "spring.datasource.primary")
@Primary
public DataSource primaryDataSource() {
    DataSource datasource = DruidDataSourceBuilder.create().build();
        return datasource;
    }

12.@Autowired

@Autowired
@Qualifier(value = "entityManagerFactoryPrimary")
LocalContainerEntityManagerFactoryBean entityManager;

13.@Resource

配置类:

@Component("jpushConfig")
public class JpushConfig {
    @Value("${jpush.appKey}")
    private String appkey;
    @Value("${jpush.masterSecret}")
    private String masterSecret;
    @Value("${jpush.liveTime}")
    private String liveTime;

    public String getAppkey() {

        return appkey;
    }

    public String getMasterSecret() {

        return masterSecret;
    }

    public void setLiveTime(String liveTime) {

        this.liveTime = liveTime;
    }
}

使用配置:

@Resource
JpushConfig jpushConfig;

14.@Value

properities属性文件中创建键值对

spring.kafka.consumer.topic=test-topic

在Java中将properities属性文件中的值,注入到属性中。

@Value("${spring.kafka.consumer.topic}")
private String topic;

15.@PathVariable

@RequestMapping("/api/{type}")
public String getUser(@PathVariable int type) {}

{type}中的type需要跟参数名统一,若不统一,可用(value = "type")指定:

@RequestMapping("/api/{type}")
public String getUser(@PathVariable(value = "type") int myType) {}

你可能感兴趣的:(Java)