1. 程式人生 > >java常用註解

java常用註解

refresh 的區別 public tst toon esp 傳遞 auto cascade

Spring的註解形式:@Repository、@Service、@Controller,它們分別對應存儲層Bean,業務層Bean,和展示層Bean。

controller層使用@controller註解

@Controller 用於標記在一個類上,使用它標記的類就是一個SpringMVC Controller 對象。分發處理器將會掃描使用了該註解的類的方法。通俗來說,被Controller標記的類就是一個控制器,這個類中的方法,就是相應的動作。
@RequestMapping是一個用來處理請求地址映射的註解,可用於類或方法上。用於類上,表示類中的所有響應請求的方法都是以該地址作為父路徑。

service采用@service註解

@Service("userService")註解是告訴Spring,當Spring要創建UserServiceImpl的的實例時,bean的名字必須叫做"userService",這樣當Action需要使用UserServiceImpl的的實例時,就可以由Spring創建好的"userService",然後註入給Action。

dao層使用@repository註解

@Repository(value="userDao")註解是告訴Spring,讓Spring創建一個名字叫“userDao”的UserDaoImpl實例。

當Service需要使用Spring創建的名字叫“userDao”的UserDaoImpl實例時,就可以使用@Resource(name = "userDao")註解告訴Spring,Spring把創建好的userDao註入給Service即可。

@Autowired

@Resource的作用相當於@Autowired,只不過@Autowired按byType自動註入,而@Resource默認按 byName自動註入罷了。@Resource有兩個屬性是比較重要的,分是name和type,Spring將@Resource註解的name屬性解析為bean的名字,而type屬性則解析為bean的類型。所以如果使用name屬性,則使用byName的自動註入策略,而使用type屬性時則使用byType自動註入策略。如果既不指定name也不指定type屬性,這時將通過反射機制使用byName自動註入策略。
  @Resource裝配順序
  1. 如果同時指定了name和type,則從Spring上下文中找到唯一匹配的bean進行裝配,找不到則拋出異常
  2. 如果指定了name,則從上下文中查找名稱(id)匹配的bean進行裝配,找不到則拋出異常
  3. 如果指定了type,則從上下文中找到類型匹配的唯一bean進行裝配,找不到或者找到多個,都會拋出異常
  4. 如果既沒有指定name,又沒有指定type,則自動按照byName方式進行裝配;如果沒有匹配,則回退為一個原始類型進行匹配,如果匹配則自動裝配;

@Autowired 與@Resource的區別:

1、 @Autowired與@Resource都可以用來裝配bean. 都可以寫在字段上,或寫在setter方法上。

2、 @Autowired默認按類型裝配(這個註解是屬業spring的),默認情況下必須要求依賴對象必須存在,如果要允許null值,可以設置它的required屬性為false,如:@Autowired(required=false) ,如果我們想使用名稱裝配可以結合@Qualifier註解進行使用,如下:

1 2 @Autowired()@Qualifier("baseDao") privateBaseDao baseDao;

3、@Resource(這個註解屬於J2EE的),默認按照名稱進行裝配,名稱可以通過name屬性進行指定,如果沒有指定name屬性,當註解寫在字段上時,默認取字段名進行安裝名稱查找,如果註解寫在setter方法上默認取屬性名進行裝配。當找不到與名稱匹配的bean時才按照類型進行裝配。但是需要註意的是,如果name屬性一旦指定,就只會按照名稱進行裝配。

1 2 @Resource(name="baseDao") privateBaseDao baseDao;

	
	//添加TestOne數據
	@PostMapping(value="/test3s")//@RequestBody 接收參數,參數是一個對象
	public ResponseEntity<Test3> saveTestOne(@RequestBody Test3 test3) {
		
		System.out.println(test3.getLastName());
		
		test3Service.save(test3);
		return new ResponseEntity<Test3>(test3, HttpStatus.OK);
		
	}
	
	//查詢TestOne數據
	@GetMapping("/test3s")
	public List<Test3> getTestOne(){
		return test3Service.findAll();
		
	}
	
	//刪除TestOne數據
	@DeleteMapping("/test3s/{id}")
	public void delete(@PathVariable("id") Long id) {
		
		test3Service.deleteOne(id);
	}
	
	//修改TestOne數據
	@PutMapping(value = "/test3s/{id}") // @RequestBody 接收參數,參數是一個對象
	public ResponseEntity<Test3> updateTestOne (@RequestBody Test3 test3) {
		
		System.out.println(test3.getLastName());
		

		test3Service.update(test3);

		return new ResponseEntity<Test3>(test3, HttpStatus.OK);
	}

@SpringBootApplication:

@SpringBootApplication = (默認屬性)@Configuration + @EnableAutoConfiguration + @ComponentScan。

@Configuration:表示將該類作用springboot配置文件類。

@EnableAutoConfiguration:表示程序啟動時,自動加載springboot默認的配置。

@ComponentScan:表示程序啟動是,自動掃描當前包及子包下所有類。

@EntityScan(basePackages="com.entity"):

@EnableJpaRepositories("com.dao"):

@ComponentScan(basePackages = { "com.controller","com.server"}):

@SpringBootApplication
@EntityScan(basePackages="com.entity")
@EnableJpaRepositories("com.dao")
@ComponentScan(basePackages = { "com.controller","com.server"})
public class App {

    public static void main(String[] args) {
        // TODO Auto-generated method stub
        SpringApplication.run(App.class,args);
    }

}

  1. @Entity(name=”EntityName”)
    必須,name為可選,對應數據庫中一的個表

  2. @Table(name=””,catalog=””,schema=””)
    可選,通常和@Entity配合使用,只能標註在實體的class定義處,表示實體對應的數據庫表的信息
    name:可選,表示表的名稱。默認地,表名和實體名稱一致,只有在不一致的情況下才需要指定表名
    catalog:可選,表示Catalog名稱,默認為Catalog("")。
    schema:可選,表示Schema名稱,默認為Schema("")。

  3. @id
    必須
    @id定義了映射到數據庫表的主鍵的屬性,一個實體只能有一個屬性被映射為主鍵.置於getXxxx()前.

  4. @GeneratedValue(strategy=GenerationType,generator=””)
    可選
    strategy:表示主鍵生成策略,有AUTO,INDENTITY,SEQUENCE 和 TABLE 4種,分別表示讓ORM框架自動選擇,
    根據數據庫的Identity字段生成,根據數據庫表的Sequence字段生成,以有根據一個額外的表生成主鍵,默認為AUTO
    generator:表示主鍵生成器的名稱,這個屬性通常和ORM框架相關,例如,Hibernate可以指定uuid等主鍵生成方式.
    示例:

  1. @Id
  2. @GeneratedValues(strategy=StrategyType.SEQUENCE)
  3. public int getPk() {
  4. return pk;
  5. }
  1. @Basic(fetch=FetchType,optional=true)
    可選
    @Basic表示一個簡單的屬性到數據庫表的字段的映射,對於沒有任何標註的getXxxx()方法,默認即為@Basic
    fetch: 表示該屬性的讀取策略,有EAGER和LAZY兩種,分別表示主支抓取和延遲加載,默認為EAGER.
    optional:表示該屬性是否允許為null,默認為true
    示例:
  1. @Basic(optional=false)
  2. public String getAddress() {
  3. return address;
  4. }
  1. @Column
    可選
    @Column描述了數據庫表中該字段的詳細定義,這對於根據JPA註解生成數據庫表結構的工具非常有作用.
    name:表示數據庫表中該字段的名稱,默認情形屬性名稱一致
    nullable:表示該字段是否允許為null,默認為true
    unique:表示該字段是否是唯一標識,默認為false
    length:表示該字段的大小,僅對String類型的字段有效
    insertable:表示在ORM框架執行插入操作時,該字段是否應出現INSETRT語句中,默認為true
    updateable:表示在ORM框架執行更新操作時,該字段是否應該出現在UPDATE語句中,默認為true.對於一經創建就不可以更改的字段,該屬性非常有用,如對於birthday字段.
    columnDefinition: 表示該字段在數據庫中的實際類型.通常ORM框架可以根據屬性類型自動判斷數據庫中字段的類型,但是對於Date類型仍無法確定數據庫中字段類型究竟是 DATE,TIME還是TIMESTAMP.此外,String的默認映射類型為VARCHAR,如果要將String類型映射到特定數據庫的BLOB或 TEXT字段類型,該屬性非常有用.
    示例:
  1. @Column(name="BIRTH", nullable="false", columnDefinition="DATE")
  2. public String getBithday() {
  3. return birthday;
  4. }
  1. @Transient
    可選
    @Transient表示該屬性並非一個到數據庫表的字段的映射,ORM框架將忽略該屬性.
    如果一個屬性並非數據庫表的字段映射,就務必將其標示為@Transient,否則,ORM框架默認其註解為@Basic
    示例:
  1. //根據birth計算出age屬性
  2. @Transient
  3. public int getAge() {
  4. return getYear(new Date()) – getYear(birth);
  5. }
  1. @ManyToOne(fetch=FetchType,cascade=CascadeType)
    可選
    @ManyToOne表示一個多對一的映射,該註解標註的屬性通常是數據庫表的外鍵
    optional:是否允許該字段為null,該屬性應該根據數據庫表的外鍵約束來確定,默認為true
    fetch:表示抓取策略,默認為FetchType.EAGER
    cascade:表示默認的級聯操作策略,可以指定為ALL,PERSIST,MERGE,REFRESH和REMOVE中的若幹組合,默認為無級聯操作
    targetEntity:表示該屬性關聯的實體類型.該屬性通常不必指定,ORM框架根據屬性類型自動判斷targetEntity.
    示例:
  1. //訂單Order和用戶User是一個ManyToOne的關系
  2. //在Order類中定義
  3. @ManyToOne()
  4. @JoinColumn(name=”USER”)
  5. public User getUser() {
  6. return user;
  7. }
  1. @JoinColumn
    可選
    @JoinColumn和@Column類似,介量描述的不是一個簡單字段,而一一個關聯字段,例如.描述一個@ManyToOne的字段.
    name:該字段的名稱.由於@JoinColumn描述的是一個關聯字段,如ManyToOne,則默認的名稱由其關聯的實體決定.
    例如,實體Order有一個user屬性來關聯實體User,則Order的user屬性為一個外鍵,
    其默認的名稱為實體User的名稱+下劃線+實體User的主鍵名稱
    示例:
    見@ManyToOne

  2. @OneToMany(fetch=FetchType,cascade=CascadeType)
    可選
    @OneToMany描述一個一對多的關聯,該屬性應該為集體類型,在數據庫中並沒有實際字段.
    fetch:表示抓取策略,默認為FetchType.LAZY,因為關聯的多個對象通常不必從數據庫預先讀取到內存
    cascade:表示級聯操作策略,對於OneToMany類型的關聯非常重要,通常該實體更新或刪除時,其關聯的實體也應當被更新或刪除
    例如:實體User和Order是OneToMany的關系,則實體User被刪除時,其關聯的實體Order也應該被全部刪除
    示例:

  1. @OneTyMany(cascade=ALL)
  2. public List getOrders() {
  3. return orders;
  4. }
  1. @OneToOne(fetch=FetchType,cascade=CascadeType)
    可選
    @OneToOne描述一個一對一的關聯
    fetch:表示抓取策略,默認為FetchType.LAZY
    cascade:表示級聯操作策略
    示例:
  1. @OneToOne(fetch=FetchType.LAZY)
  2. public Blog getBlog() {
  3. return blog;
  4. }
  1. @ManyToMany
    可選
    @ManyToMany 描述一個多對多的關聯.多對多關聯上是兩個一對多關聯,但是在ManyToMany描述中,中間表是由ORM框架自動處理
    targetEntity:表示多對多關聯的另一個實體類的全名,例如:package.Book.class
    mappedBy:表示多對多關聯的另一個實體類的對應集合屬性名稱
    示例:
  1. /**
  2. * User實體表示用戶,Book實體表示書籍,為了描述用戶收藏的書籍,
  3. * 可以在User和Book之間建立ManyToMany關聯
  4. */
  5. @Entity
  6. public class User {
  7.   private List books;
  8.    @ManyToMany(targetEntity=package.Book.class)
  9.   public List getBooks() {
  10.   return books;
  11. }
  12.   public void setBooks(List books) {
  13.      this.books=books;
  14.   }
  15. }
  16. @Entity
  17. public class Book {
  18. private List users;
  19.   @ManyToMany(targetEntity=package.Users.class, mappedBy=”books”)
  20.    public List getUsers() {
  21.      return users;
  22.    }
  23.   public void setUsers(List users) {
  24.      this.users=users;
  25.   }
  26. }

兩個實體間相互關聯的屬性必須標記為@ManyToMany,並相互指定targetEntity屬性,
需要註意的是,有且只有一個實體的@ManyToMany註解需要指定mappedBy屬性,指向targetEntity的集合屬性名稱
利用ORM工具自動生成的表除了User和Book表外,還自動生成了一個User_Book表,用於實現多對多關聯

  1. @MappedSuperclass
    可選
    @MappedSuperclass可以將超類的JPA註解傳遞給子類,使子類能夠繼承超類的JPA註解
    示例:
  1. @MappedSuperclass
  2. public class Employee() {
  3. ….
  4. }
  5. @Entity
  6. public class Engineer extends Employee {
  7. …..
  8. }
  9. @Entity
  10. public class Manager extends Employee {
  11. …..
  12. }
  1. @Embedded
    可選
    @Embedded將幾個字段組合成一個類,並作為整個Entity的一個屬性.
    例如User包括id,name,city,street,zip屬性.
    我們希望city,street,zip屬性映射為Address對象.這樣,User對象將具有id,name和address這三個屬性.
    Address對象必須定義為@Embededable
    示例:
  1. @Embeddable
  2. public class Address {city,street,zip}
  3. @Entity
  4. public class User {
  5. @Embedded
  6. public Address getAddress() {
  7. ……….
  8. }
  9. }

Hibernate驗證註解

  1. 註解 適用類型 說明 示例
  2. @Pattern String 通過正則表達式來驗證字符串 @attern(regex=”[a-z]{6}”)
  3. @Length String 驗證字符串的長度 @length(min=3,max=20)
  4. @Email String 驗證一個Email地址是否有效 @email
  5. @Range Long 驗證一個整型是否在有效的範圍內 @Range(min=0,max=100)
  6. @Min Long 驗證一個整型必須不小於指定值 @Min(value=10)
  7. @Max Long 驗證一個整型必須不大於指定值 @Max(value=20)
  8. @Size 集合或數組 集合或數組的大小是否在指定範圍內 @Size(min=1,max=255)

java常用註解