SpringBoot常用注解

Java Config 相关

@SpringBootApplication

申明让spring boot自动给程序进行必要的配置，这个配置等同于：@Configuration ，@EnableAutoConfiguration 和 @ComponentScan 三个配置。

@Configuration

指出该类是 Bean 配置的信息源，相当于XML中的，一般加在主类上。

@ImportResource

用来加载xml配置文件。

@ComponentScan

组件扫描。相当于< context:component-scan >，如果扫描到有@Component @Controller @Service等这些注解的类，则把这些类注册为bean。

@Bean

相当于XML中的,放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理。

@ConfigurationProperties

Spring Boot将尝试校验外部的配置，默认使用JSR-303（如果在classpath路径中）。

你可以轻松的为你的@ConfigurationProperties类添加JSR-303 javax.validation约束注解：

@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
@NotNullprivate InetAddress remoteAddress;
// ... getters and setters
}

定义相关

**@Component **

泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

@Repository

用于标注数据访问组件，即DAO组件。

@Service

用于标注业务层组件。

@Controller

用于定义控制器类，在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口（service层），一般这个注解在类中，通常方法需要配合注解@RequestMapping。

@RestController

用于标注控制层组件(如struts中的action)，包含@Controller和@ResponseBody

@RequestMapping

RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。

该注解有六个属性：

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

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

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

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

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

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

注入相关

@Autowired

byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。 当加上（required=false）时，就算找不到bean也不报错。

@Qualifier

当有多个同一类型的Bean时，可以用@Qualifier("name")来指定。与@Autowired配合使用

@Autowired
@Qualifier(value = “demoInfoService”)
private DemoInfoService demoInfoService;

@Resource(name="name",type="type")

没有括号内内容的话，默认byName。与@Autowired干类似的事。

@Value

注入Spring boot application.properties配置的属性的值。

@Value(value = “#{message}”)
private String message;

常用 JPA

实体

@Entity

用于添加在实体类上，定义该JAVA类成为被JPA管理的实体，将映射到指定的数据库表。如定义一个实体类Category，它将映射到数据库中的category表中。

@MappedSuperclass

通过这个注解，我们可以将该实体类当成基类实体，它不会隐射到数据库表，但继承它的子类实体在隐射时会自动扫描该基类实体的隐射属性，添加到子类实体的对应数据库表中。

@Table(name)

属性name，表的名字，如果不写，系统认为和实体类一致。

属性catalog，schema用于设置目录和此表所在schema，一般不需要填写；

属性uniqueConstraints，唯一性约束，只有创建表的时候有用，默认不需要；

属性indexes，索引，只有创建表的时候有用，默认不需要。

主键

@Id

定义属性为数据库表中的主键列，一个实体里面必须有一个。

@GeneratedValue(strategy, generator)

属性strategy，id的生成策略，GenerationType.TABLE，通过表产生主键，框架由表模拟序列产生主键，使用该策略可以使应用更易于数据库移植；GenerationType.SEQUENCE，通过序列产生主键，通过@SequenceGenerator注解指定序列名，MySql不支持这种方式；GenerationType.IDENTITY,数据库id自增长，多用于MySql；GenerationType.AUTO,JPA自动选择合适的策略，默认选项。

属性generator：通过Sequence生成id，常见Orcale数据库id生成，需要配合@SequenceGenerator使用。

@SequenceGenerator(name, sequenceName)

SequenceGenerator定义一个主键值生成器，在Id这个元数据的generator属性中可以使用生成器的名字。生成器可以在类、方法或者属性上定义。生成器是数据库支持的sequence对象。

元数据属性说明：

  • name:生成器的唯一名字，可以被Id元数据使用。
  • sequenceName:数据库中，sequence对象的名称。如果不指定，会使用提供商指定的默认名称。
  • initialValue:id值的初始值。
  • allocationSize:id值的增量。

下面的代码定义了一个使用提供商默认名称的sequence生成器。

@SequenceGenerator(name="EMP_SEQ", allocationSize=25)

映射

@Column(name, nullable, length, insertable, updatable)

定义该属性对应数据库中的列名。

属性name，数据库中的列名。如果不写默认和实体属性名一致；

属性unique，是否唯一。默认false；

属性nullable，是否允许为空。默认为true；

属性insertable，执行insert操作的时候是否包含此字段，默认为true；

属性updatable，执行updatable操作的时候是否包含此字段，默认为true；

属性columnDefinition，表示该字段在数据库中的实际类型。

属性length，数据库字段的长度，默认255；

属性table,precision，scale，我没用到过，一般不设置。

@JoinTable(name)、 @JoinColumn(name)

JoinTable在many-to-many关系的所有者一边定义。如果没有定义JoinTable，使用JoinTable的默认值。

元数据属性说明：

  • table:这个join table的Table定义。

  • joinColumns:定义指向所有者主表的外键列，数据类型是JoinColumn数组。

  • inverseJoinColumns:定义指向非所有者主表的外键列，数据类型是JoinColumn数组。

下面的代码定义了一个连接表CUST和PHONE的join table。join table的表名是CUST_PHONE，包含两个外键，一个外键是CUST_ID，指向表CUST的主键ID，另一个外键是PHONE_ID，指向表PHONE的主键ID。

@JoinTable(
table=@Table(name=CUST_PHONE),
joinColumns=@JoinColumn(name="CUST_ID", referencedColumnName="ID"),
inverseJoinColumns=@JoinColumn(name="PHONE_ID", referencedColumnName="ID")
)

关系

@OneToOne、 @OneToMany、 @ManyToOne、 @ManyToMany

对应hibernate配置文件中的一对一，一对多，多对一。

@OneToOne描述一个 一对一的关联

元数据属性说明：

  • fetch：表示抓取策略，默认为FetchType.LAZY
  • cascade：表示级联操作策略
@OneToOne(fetch=FetchType,cascade=CascadeType)

@OrderBy

在一对多，多对多关系中，有时我们希望从数据库加载出来的集合对象是按一定方式排序的，这可以通过OrderBy来实现，默认是按对象的主键升序排列。

• value: 字符串类型，指定排序方式。 格式为"fieldName1 [ASC|DESC],fieldName2 [ASC|DESC],…",排序类型可以不指定，默认是ASC。

下面的代码说明Person和Book之间是一对多关系。集合books按照Book的isbn升序，name降序排列。

@Table(name = "MAPKEY_PERSON")
public class Person {
	@OneToMany(targetEntity = Book.class, cascade = CascadeType.ALL, mappedBy = "person")
	@OrderBy(name = "isbn ASC, name DESC")
	private List books = new ArrayList();
}

posted on 2020-03-17 11:08  MrSmartLin  阅读(379)  评论(0)  编辑  收藏  举报

导航