Giới thiệu các Annotation cơ bản trong Spring Boot
- Tram Ho
Mở Đầu
Trong quá trình sử dụng Spring Framework để lập trình, đặc biệt là Spring Boot. Chắc hẳn các bạn đã gặp các Annotation (Chú thích) là điều khó tránh khỏi. Nó thường hay sử dụng để cung cấp thông tin dữ liệu cho đoạn source code Java của bạn.
Bài viết sau đây, mình xin giải thích và hướng dẫn sử dụng một số annotation thường gặp nhiều nhất.
Các kiến thức cần nắm
- Dependency Injection (DI) Là một design pattern, một cách code nhằm giảm sự phụ thuộc giữa các Object để tiện cho việc thay đổi hay mở rộng code sau này. Các Object nên phục thuộc vào các Abstract Class và thể hiện chi tiết của nó sẽ được Inject vào lúc runtime chương trình.
- Inversion of Control (IoC):
→ Tuy nhiên khi có nhiều Dependency (>10) chúng ta phải tiêm (Injection) cho các denpendency này thì rất mất thời gian.
→ Tưởng tượng một Class bản thân phải Inject cho hàng chục dependency thì rất mất thời gian.- Thay vì cách khởi tạo các Object như cách thông thường thì ra đảo ngược lại chiều điều khiển để cho Spring tạo Object, quản lí bộ nhớ cho các Object thay việc của chúng ta. (ĐẢO NGƯỢC CHIỀU ĐIỀU KHIỂN)
- Spring Container là nơi chứa đựng tất cả các Bean.
- Đọc thêm ở:
→ DI & IoC
→ Spring Container
@Autowire
- Tự động nhúng các bean được Spring Container sinh ra vào các class được khai báo @Autowire (theo cơ chế Dependency Injection)
→ Cơ chế khi Spring bắt đầu chạy nó sẽ quét qua các lớp có sử dụng annotation để tạo Bean.
→ Đồng thời sẽ tìm kiếm xem trong các bean đó có khai báo @Autowire không, nó sẽ tìm kiếm các bean tương ứng để tiêm (Injection) vào bean đó.- Sử dụng @Autowire với 3 trường hợp sau:
1 2 3 4 5 6 7 8 9 10 11 | <span class="token comment">//Properties</span> <span class="token annotation punctuation">@Service</span> <span class="token keyword">public</span> <span class="token keyword">class</span> <span class="token class-name">UserService</span> <span class="token punctuation">{</span> <span class="token annotation punctuation">@Autowired</span> <span class="token class-name">UserRepository</span> userRepository<span class="token punctuation">;</span> <span class="token annotation punctuation">@Autowired</span> <span class="token class-name">FacebookUtil</span> facebookUtil<span class="token punctuation">;</span> <span class="token punctuation">}</span> |
1 2 3 4 5 6 7 8 9 10 11 12 | <span class="token comment">//Setter</span> <span class="token annotation punctuation">@Service</span> <span class="token keyword">public</span> <span class="token keyword">class</span> <span class="token class-name">User</span> <span class="token punctuation">{</span> <span class="token class-name">Private</span> <span class="token class-name">String</span> name<span class="token punctuation">;</span> <span class="token annotation punctuation">@Autowire</span> <span class="token keyword">void</span> <span class="token function">setName</span><span class="token punctuation">(</span><span class="token class-name">String</span> name<span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">this</span><span class="token punctuation">.</span>name <span class="token operator">=</span> name<span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | <span class="token comment">//Contructor</span> <span class="token annotation punctuation">@Service</span> <span class="token keyword">public</span> <span class="token keyword">class</span> <span class="token class-name">User</span> <span class="token punctuation">{</span> <span class="token keyword">private</span> <span class="token keyword">long</span> id<span class="token punctuation">;</span> <span class="token keyword">private</span> <span class="token class-name">String</span> name<span class="token punctuation">;</span> <span class="token annotation punctuation">@Autowire</span> <span class="token keyword">void</span> <span class="token function">user</span><span class="token punctuation">(</span><span class="token keyword">long</span> id<span class="token punctuation">,</span> <span class="token class-name">String</span> name<span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">this</span><span class="token punctuation">.</span>id <span class="token operator">=</span> id<span class="token punctuation">;</span> <span class="token keyword">this</span><span class="token punctuation">.</span>name <span class="token operator">=</span> name<span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> |
@Configuration
- Được sử dụng để chỉ ra rằng, Class khai báo sử dụng @Configuration sẽ khai báo một hoặc nhiều @Bean method trong class đó.
→ Thông thường các Bean cấu hình trong dự án ta sẽ để trong các lớp configuration này. Ví dụ cấu hình Elasticsearch, Thymeleaf, đa ngôn ngữ,…
@Bean
- Đánh dấu trên method thông báo cho Spring, method đó sẽ sinh ra một bean và được quản lí bởi Spring Container.
→ Tất cả các Method sử dụng annotation @Bean phải nằm trong class Configuration.
1 2 3 4 5 6 7 8 9 10 | <span class="token annotation punctuation">@Configuration</span> <span class="token keyword">public</span> <span class="token keyword">class</span> <span class="token class-name">WebDriverConfig</span> <span class="token punctuation">{</span> <span class="token annotation punctuation">@Bean</span> <span class="token keyword">public</span> <span class="token class-name">WebDriver</span> <span class="token class-name">Chrome</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token class-name">System</span><span class="token punctuation">.</span><span class="token function">setProperty</span><span class="token punctuation">(</span><span class="token string">"webdriver.chrome.driver"</span><span class="token punctuation">,</span> <span class="token string">"/Downloads/chromedriver_linux64/chromedriver"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">return</span> <span class="token keyword">new</span> <span class="token class-name">ChromeDriver</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> |
@ComponentScan
- Sử dụng annotation này để thông báo cho spring container rằng: “Phải biết vào các package nào trong dự án để quét các Annotation và tạo Bean.”
1 2 3 4 5 6 | <span class="token annotation punctuation">@Configuration</span> <span class="token annotation punctuation">@ComponentScan</span><span class="token punctuation">(</span>basePackages <span class="token operator">=</span> <span class="token string">"minhchuan.spring "</span><span class="token punctuation">)</span> <span class="token keyword">public</span> <span class="token keyword">class</span> <span class="token class-name">SpringComponentDemo</span> <span class="token punctuation">{</span> <span class="token comment">// ...</span> <span class="token punctuation">}</span> |
@Component
- Khi một class sử dụng annotation này: “Thì sẽ được tạo thành 1 Bean, và tiêm vào các lớp nào cần dùng tới nó”
| Component | Configuration |
|---|---|
| Sẽ không thể @Autowire một lớp nếu lớp đó không sử dụng @Component. | Nó giống như file Bean.xml dùng để khai báo các bean . |
| Khi bạn muốn xác định lớp để Injection thì phải đánh dấu bằng cách sử dụng annotation này để spring biết. | Sẽ được spring tự động phát hiện. |
@Service
- Đây là annotation đặc biệt của @Component. Được dùng để sử lý nghiệp vụ, logic.
1 2 3 4 5 6 7 8 9 10 | <span class="token annotation punctuation">@Service</span> <span class="token keyword">public</span> <span class="token keyword">class</span> <span class="token class-name">UserService</span> <span class="token punctuation">{</span> <span class="token annotation punctuation">@Autowired</span> <span class="token class-name">UserRepository</span> userRepository<span class="token punctuation">;</span> <span class="token annotation punctuation">@Autowired</span> <span class="token class-name">FacebookUtil</span> facebookUtil<span class="token punctuation">;</span> <span class="token punctuation">}</span> |
@Repository
- Đây cũng là một annotation đặc biệt của @Component. Được dùng để thao các với cơ sở dữ liệu.
- Jpa sẽ cung cấp cho các hàm select, update,… cơ bản. Có thể áp dụng thêm Query Creation.
- Các Interface thường gặp: CrudRepository, JpaRepository, MongoRepository,…
1 2 3 4 5 | <span class="token annotation punctuation">@Repository</span> <span class="token keyword">public</span> <span class="token keyword">interface</span> <span class="token class-name">UserRepository</span> <span class="token keyword">extends</span> <span class="token class-name">JpaRepository</span> <span class="token generics"><span class="token punctuation"><</span><span class="token class-name">User</span><span class="token punctuation">,</span> <span class="token class-name">Integer</span><span class="token punctuation">></span></span> <span class="token punctuation">{</span> <span class="token comment">//Query Creation</span> <span class="token punctuation">}</span> |
@Scope
- Đây là phạm vi Bean được sinh ra và bị phá hủy dưới sự quản lí của Spring Container. Khi Bean sinh ra có các phạm vi được sử dụng và các tùy chỉnh của nó:
- Singleton: Đây sẽ là scope mặc định của 1 bean khi được sinh ra. nó có nghĩa: “bean chỉ tạo 1 lần và sử dụng trong container. Chỉ duy nhất một bean tồn tại trong container”.
→ Có nghĩa là tại 1 thời điểm Container chỉ load một Bean nhất định. - Prototype: ngược lại với Singleton, ta muốn có nhiều Bean thì sử dụng scope này.
- Request: Bean được sinh ra thông qua các HTTP Request của người dùng. Chỉ được dụng trong các ứng dụng Web.
- Session: Bean được sinh ra thông qua các HTTP Session.
- Singleton: Đây sẽ là scope mặc định của 1 bean khi được sinh ra. nó có nghĩa: “bean chỉ tạo 1 lần và sử dụng trong container. Chỉ duy nhất một bean tồn tại trong container”.
@PropertySource & @Value
- Chúng ta sử dụng @PropertySource để cho Spring biết tìm các file properties cấu hình cho hệ thống ở đâu.
- Đồng thời sử dụng @Value để lấy giá trị trong file properties.
1 2 3 4 5 6 7 8 9 10 11 | <span class="token annotation punctuation">@Configuration</span> <span class="token annotation punctuation">@PropertySource</span><span class="token punctuation">(</span><span class="token string">"classpath:application.properties"</span><span class="token punctuation">)</span> <span class="token keyword">public</span> <span class="token keyword">class</span> <span class="token class-name">MongoDBConfiguration</span> <span class="token punctuation">{</span> <span class="token annotation punctuation">@Value</span><span class="token punctuation">(</span><span class="token string">"${mongodb.url}"</span><span class="token punctuation">)</span> <span class="token keyword">private</span> <span class="token class-name">String</span> url<span class="token punctuation">;</span> <span class="token annotation punctuation">@Value</span><span class="token punctuation">(</span><span class="token string">"${mongodb.db}"</span><span class="token punctuation">)</span> <span class="token keyword">private</span> <span class="token class-name">String</span> name<span class="token punctuation">;</span> <span class="token punctuation">}</span> |
@Valid
- Dùng để kiểm tra dữ liệu có đúng như mình mong muốn hay không.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <span class="token annotation punctuation">@Entity</span> <span class="token keyword">public</span> <span class="token keyword">class</span> <span class="token class-name">User</span> <span class="token punctuation">{</span> <span class="token annotation punctuation">@Id</span> <span class="token annotation punctuation">@GeneratedValue</span> <span class="token keyword">private</span> <span class="token class-name">Long</span> id<span class="token punctuation">;</span> <span class="token annotation punctuation">@NotEmpty</span><span class="token punctuation">(</span>message <span class="token operator">=</span> <span class="token string">"Please provide a name"</span><span class="token punctuation">)</span> <span class="token keyword">private</span> <span class="token class-name">String</span> name<span class="token punctuation">;</span> <span class="token annotation punctuation">@NotEmpty</span><span class="token punctuation">(</span>message <span class="token operator">=</span> <span class="token string">"Please provide a className"</span><span class="token punctuation">)</span> <span class="token keyword">private</span> <span class="token class-name">String</span> className<span class="token punctuation">;</span> <span class="token comment">//...</span> <span class="token punctuation">}</span> <span class="token annotation punctuation">@RestController</span> <span class="token keyword">public</span> <span class="token keyword">class</span> <span class="token class-name">UserController</span> <span class="token punctuation">{</span> <span class="token annotation punctuation">@PostMapping</span><span class="token punctuation">(</span><span class="token string">"/users"</span><span class="token punctuation">)</span> <span class="token class-name">Book</span> <span class="token function">newBook</span><span class="token punctuation">(</span><span class="token annotation punctuation">@Valid</span> <span class="token annotation punctuation">@RequestBody</span> <span class="token class-name">User</span> user<span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token comment">//...</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> |
=> Ở trường hợp này nếu như Object User bị null ở properties (name, className) thì sẽ bị bắt lỗi.
@ReponseBody
- Thông báo cho người dùng biết rằng APIở controller, sẽ trả về một đối tượng Object kiểu Json cho client chứ không render ra một trang view.
Kết
Như vậy là đã xong rồi đấy! Hi vọng bạn hiểu được cách sử dụng các Annotation làm việc thông qua trong các ví dụ nhỏ này.
Ví dụ này cũng khá là phức tạp, nên có khi bạn sẽ phải đọc đi đọc lại nhiều lần, nhưng hãy kiên nhẫn nhé!
Cảm ơn các bạn đã đọc bài