Springboot系列：Springboot常用注解以及使用！

Springboot系列：Springboot常用注解以及使用！

---

前言

今天博主将为大家分享:Springboot系列：Springboot常用注解以及使用！不喜勿喷，如有异议欢迎讨论！

---

常规方式

注解	使用位置	作用
@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
用在类名

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

2.@RequestMapping 和请求报文是做对应

a：value，指定请求的地址 　　

b：method 请求方法类型 这个不写的话，自适应：get或者post 　
\　
c：consumes请求的提交内容类型 　　

d：produces 指定返回的内容类型 仅当request请求头中的(Accept)类型中包含该指定类型才返回
　　
e: params 指定request中必须包含某些参数值 　　

f：headers 指定request中必须包含指定的header值

用在类名

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

用在方法名

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

注解属性：
①. 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
用在方法名上

将返回对象输出到客户端，如果是字符串，直接输出；如果不是，则默认用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> kafkaListenerContainerFactory() {
    ConcurrentKafkaListenerContainerFactory 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) {}

16.@Scope：注解在类上，描述spring容器如何创建Bean实例。

（1）singleton： 表示在spring容器中的单例，通过spring容器获得该bean时总是返回唯一的实例

（2）prototype：表示每次获得bean都会生成一个新的对象

（3）request：表示在一次http请求内有效（只适用于web应用）

（4）session：表示在一个用户会话内有效（只适用于web应用）

（5）globalSession：表示在全局会话内有效（只适用于web应用）

17.@ConfigurationProperties

赋值，将注解转换成对象。给对象赋值。车险项目：HttpClientSetting类

@Profile：注解在方法类上在不同情况下选择实例化不同的Bean特定环境下生效！！！！！！！！！！！！！！！！！

18.@SpringBootApplication

@SpringBootApplication=@ComponentScan+@Configuration+@EnableAutoConfiguration：约定优于配置

@EnableAutoConfiguration启用 Spring 应用程序上下文的自动配置，试图猜测和配置您可能需要的bean。自动配置类通常采用基于你的classpath 和已经定义的 beans 对象进行应用。被@EnableAutoConfiguration 注解的类所在的包有特定的意义，并且作为默认配置使用。通常推荐将

@EnableAutoConfiguration 配置在 root 包下，这样所有的子包、类都可以被查找到。

19.@ComponentScan

注解在类上，扫描标注了@Controller等注解的类，注册为bean 。@ComponentScan 为
@Configuration注解的类配置组件扫描指令。@ComponentScan 注解会自动扫描指定包下的全部标有 @Component注解的类，并注册成bean，当然包括 @Component下的子注解@Service、@Repository、@Controller。

20.@RequestParam(value=“username”,required=false)

使用@RequestParam时，URL是这样的：http://host:port/path?参数名=参数值

使用@PathVariable时，URL是这样的：http://host:port/path/参数值

不写的时候也可以获取到参数值，但是必须名称对应。参数可以省略不写

21.@suppresswarnings 抑制警告

@Modifying 如果是增，改，删加上此注解

1：方法的返回值应该是int，表示更新语句所影响的行数。

2：在调用的地方必须加事务，没有事务不能正常执行。@Transactional 事务注解

@Query 自定义查询语句 JPQL

---

JPA注解

@Entity：

@Table(name=“”)：注解在类上表明这是一个实体类。一般用于jpa这两个注解一般一块使用，但是如果表名和实体类名相同的话，@Table可以省略

@Column：通过@Column注解设置，包含的设置如下

name：数据库表字段名
unique：是否唯一
nullable：是否可以为空

• Length:长度

inserttable：是否可以插入

updateable：是否可以更新

columnDefinition: 定义建表时创建此列的DDL

secondaryTable: 从表名。如果此列不建在主表上（默认建在主表），该属性定义该列所在从表的名字。

@Column(name = “user_code”, nullable = false, length=32)//设置属性userCode对应的字段为user_code，长度为32，非空 private String
userCode; @Column(name = “user_wages”, nullable = true, precision=12,scale=2)//设置属性wages对应的字段为user_wages，12位数字可保留两位小数，可以为空
private double wages;

@Id：表示该属性为主键。

@Temporal(TemporalType.DATE)//设置为时间类型 private Date joinDate;

@Transient：表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic。@Basic(fetch=FetchType.LAZY)：标记可以指定实体属性的加载方式

@JsonIgnore：作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。

@JoinColumn（name=”loginId”）:一对一：本表中指向另一个表的外键。一对多：另一个表指向本表的外键。

@OneToOne、@OneToMany、@ManyToOne：对应hibernate配置文件中的一对一，一对多，多对一。

@GeneratedValue 用于标注主键的生成策略，通过 strategy 属性指定。默认情况下，JPA 自动选择一个最适合底层数据库的主键生成策略：SqlServer 对应 identity，MySQL 对应 auto increment。 在 javax.persistence.GenerationType 中定义了以下几种可供选择的策略：

IDENTITY：采用数据库 ID自增长的方式来自增主键字段，Oracle 不支持这种方式；

AUTO： JPA自动选择合适的策略，是默认选项；

SEQUENCE：通过序列产生主键，通过 @SequenceGenerator 注解指定序列名，MySql 不支持这种方式

TABLE：通过表产生主键，框架借由表模拟序列产生主键，使用该策略可以使应用更易于数据库移植。

---

到这里:Springboot系列：Springboot常用注解以及使用！分享完毕了，快去试试吧！

---

最后

• 更多参考精彩博文请看这里：《陈永佳的博客》

• 喜欢博主的小伙伴可以加个关注、点个赞哦，持续更新嘿嘿！

---