1.1.4.2 Eclipse
Eclipse là một IDE miễn phí khác dành cho lập trình Java được giới thiệu vào tháng 11 năm 2001. Eclipse được viết gần như tồn bộ bởi Java, nó hỗ trợ xây dựng các ứng dụng Java đa nền tảng sử dụng cho mobile, web, desktop hay lĩnh vực doanh nghiệp.
Ngoài ra IDE này cũng hỗ trợ phát triển ứng dụng với các ngơn ngữ lập trình khác như C. C++, C#, Python, Ruby hay thậm chí tạo tài liệu với LaTex thông qua các plugins.
1.1.4.3 Visual Studio Code
Visual Studio Code được công bố, ra mắt phiên bản thử nghiệm vào ngày 29 tháng 4 năm 2015 bởi Microsoft tại hội nghị Build 2015. Vào ngày 18 tháng 11 năm 2015, Visual Studio Code được phát hành dưới giấy phép MIT và mã nguồn của nó được đưa lên GitHub. Vào ngày 14 tháng 4 năm 2016 Visual Studio Code hoàn tất thử nghiệm và được phát hành chính thức.
Visual Studio Code là một trình biên tập mã, hỗ trợ nhiều ngôn ngữ và chức năng tùy vào ngôn ngữ sử dụng như Java, C++, Python, Ruby,... Nhiều chức năng của Visual Studio Code không hiển thị ra trong các menu tùy chọn hay giao diện người dùng. Thay vào đó, chúng được gọi thơng qua khung nhập lệnh hoặc qua một tập tin .json. Tuy nhiên, nó biến mất khi người dùng nhấp bất cứ nơi nào khác, hoặc nhấn tổ hợp phím để tương tác với một cái gì đó ở bên ngồi đó. Tương tự như vậy với những dịng lệnh tốn nhiều thời gian để xử lý. Khi thực hiện những điều trên thì q trình xử lý dịng lệnh đó sẽ bị hủy.
Người dùng có thể dễ dàng download và sử dụng trên các hệ điều hành Window, MacOs và Linux.
Hình 1. 6: Hình ảnh Visual Studio Code
1.2. Tìm hiểu về Spring Boot
1.2.1 Spring Boot là gì?
Spring là một Framework được ra đời để giúp các nhà phát triển có thể xây dựng hệ thống và chạy ứng dụng trên JVM một cách thuận tiện, đơn giản và nhanh chóng. Đây là một mã nguồn mở được phát triển và rất nhiều người sử dụng.
Trên thực tế, Spring Framework là tập hợp gồm rất nhiều các dự án nhỏ khác nhau như: Spring MVC (sử dụng để xây dựng các ứng dụng trên nền tảng web), Spring Data, Spring Boot,...
Để phát triển một ứng dụng web cơ bản sử dụng Spring framework, bạn cần trải qua ít nhất 5 cơng đoạn sau:
● Tạo một project sử dụng Maven với các dependency cần thiết.
● Tạo một tập tin web đuôi (.xml) để khai báo DispatcherServlet (thuộc Spring MVC).
● Một tập tin có cấu hình của Spring MVC.
● Trả về một class Controller khi có request đến.
● Cuối cùng là phải có một web server phục vụ triển khai ứng dụng chạy.
Để khởi tạo một dự án Spring khá là vất vả và tốn nhiều cơng sức. Người lập trình phải khai báo những dependency trong pom.xml, cấu hình XML hoặc các annotation cực kỳ phức tạp. Giờ đây, việc tạo ra các ứng dụng này sẽ được thực hiện một cách đơn giản, nhanh chóng hơn rất nhiều chỉ với Spring Boot.
1.2.1.2 Khái niệm về Spring Boot.
Spring Boot là một Java framework siêu to và khổng lồ và có nhiều khả năng hữu ích vì nó có thể giúp lập trình viên giải quyết rất nhiều vấn đề. So với framework Spring thông thường, Spring Boot tỏ ra những lợi thế vượt trội. Khi sử dụng Spring Boot, rất nhiều thứ được cải tiến hỗ trợ lập trình viên như:
● Auto config: tự động cấu hình thay lập trình viên, bạn chỉ cần viết code và tiến hành chạy hệ thống là được.
● Dựa trên các Annotation để tạo lập các bean thay vì XML.
● Server Tomcat có thể được nhúng ngay trong file JAR build ra và có thể chạy ở bất kì đâu mà java chạy được.
Khi sử dụng Spring Boot, lập trình viên chỉ cần:
● Sử dụng Spring Initializr: nhập các thông tin của dự án (project), chọn thư viện (Library) rồi tải code về máy.
● Có thể chạy ngay trong IDE, hoặc build thành file JAR mà khơng cần cấu hình config cho server nữa.
Hình 1. 7: Hình ảnh giao diện Spring Boot 1.2.2 Ưu điểm của Spring Boot.
Spring Boot giúp các lập trình viên tập trung tốt hơn đến mục tiêu viết code của mình thay vì phải lo nghĩ nhiều đến các kỹ thuật code như với Node.js.
Bản thân Spring Boot chứa đựng nhiều các library bên trong, cấu trúc code cũng trở nên chuẩn mực hơn, không cần phải quá bận tâm đến việc code làm sao cho thật tốt. Do đó, có nhiều thời gian hơn để tập trung vào sự logic của sản phẩm.
Spring Boot là sự cải tiến tuyệt vời của Spring, cải thiện được rất nhiều khâu rườm rà đến từ Spring. Hơn thế, quá trình học hỏi và tiếp thu Spring Boot cũng trở nên dễ dàng hơn rất nhiều. (adsbygoogle = window.adsbygoogle || []).push({});
Spring Boot làm đơn giản hóa cấu hình và xây dựng được các ứng dụng độc lập có khả năng chạy bằng java-jar nhờ các dependency starter.
Các lập trình viên có thể dễ dàng deploy vì các ứng dụng server được nhúng trực tiếp vào ứng dụng để tránh những khó khăn khi triển khai lên môi trường production mà không cần thiết phải tải file WAR.
Cấu hình của Spring Boot ít, tự động được hỗ trợ bất cứ khi nào cho chức năng spring như tăng năng suất, giảm thời gian viết code và không yêu cầu XML config.
Spring Boot cung cấp nhiều plugin, số liệu, cấu hình ứng dụng từ bên ngồi.
1.2.3 Các tính năng cơ bản của Spring Boot
Khi một nhà phát triển sử dụng Spring, người ta có thể dễ dàng loại bỏ các mã soạn sẵn, nhưng trong q trình hồn thành chức năng được nhập từ mã khác, mọi thứ trong mã
cần phải tương thích, điều này trở thành một nhiệm vụ lớn đối với nhà phát triển. Vì vậy, để giải quyết quy trình khắc phục sự cố tương thích rườm rà trên, Spring Boot có các tính năng để xử lý nó.
1.2.3.1 Spring Application
Một trong những tính năng của Spring Boot đó là Spring Application. Đây là một class trong Spring Boot cho phép nhà phát triển khởi động ứng dụng Spring một cách thuận tiện bằng cách khởi động nó từ phương thức chính. Nhiều khi sử dụng phương thức .run() sẽ cho phép ứng dụng được chạy.
1.2.3.2 Externalized Configuration
Spring Boot cho phép chúng ta cấu hình từ bên ngồi (externalize), do đó một ứng dụng có thể chạy trên nhiều mơi trường khác nhau.
Chúng ta có thể sử dụng file YAML, file properties, các biến môi trường và tham số command-line để thực hiện externalize configuration.
Các thuộc tính cấu hình có thể inject trực tiếp vào bean bằng cách sử dụng annotation
@Value hoặc thơng qua object với @ConfigurationProperties...
Hình 1. 8: Hình ảnh ví dụ về Externalized Configuration
1.2.3.3 Các file Properties
Việc hỗ trợ các file YAML là một giải pháp thay thế thành công cho các file properties. Các file properties khơng là gì ngồi một văn bản bao gồm một tập hợp các thuộc tính cần thiết để ứng dụng chạy.
Ví dụ : khi sử dụng server-port = 8080 có nghĩa là cổng được sử dụng để chạy máy chủ là 8080.
1.2.3.4 Ghi log
Spring Boot sử dụng common logging cho tất cả chức năng log nội bộ.
Các dependency logging được quản lý mặc định, vì vậy khơng nên hoặc khơng cần sửa các dependency logging nếu các tùy biến customization khơng được u cầu.
Spring Boot có tính bảo mật cao. Khi Spring Security được bật trong classpath, các ứng dụng web được bảo mật theo mặc định. Spring Boot xác định việc sử dụng httpBasic hoặc formLogin theo yêu cầu.
Ngồi ra, Spring Boot cịn rất nhiều tính năng tương tự khác như : Developing web Applications, Working with SQL Technologies, Messaging, Caching, Calling rest Services with RestTemplate/WebClient, Sending Email, Validation,...
1.3. Swagger.
1.3.1 OpenAPI là gì?
OpenAPI được biết đến với tên đầy đủ là Open API Specification. Đây được biết đến là một loại định dạng dùng để mô tả API cho một Rest APIs hiện nay. Với duy nhất một file OpenAPI bạn sẽ có thể mơ tả được tồn bộ API. Điều này có nghĩa là việc mơ tả sẽ bao gồm cả những nội dung sau đây:
Tạo điều kiện hoạt động các endpoints hay là các users cũng như cách thức hoạt động của các endpoints đó như get/users, post/users.
Hiển thị rõ được các tham số về đầu vào và đầu ra của mỗi hoạt động. Thể hiện các phương thức xác thực được sử dụng.
Thể hiện các thông tin liên lạc, các chứng chỉ, những điều khoản liên quan đến việc sử dụng và các thông tin liên quan khác.
Thực tế thì API Specifications hiện có thể được viết bằng các định dạng như JSON hay YAML. Đây được biết đến là hai định dạng có lợi cho cả người dùng và hệ thống máy tính khi rất dễ đọc và dễ hiểu để sử dụng. (adsbygoogle = window.adsbygoogle || []).push({});
OpenAPI cần tạo mẫu đường dẫn đề cập việc sử dụng các biểu thức mẫu, được phân tách bằng dấu ngoặc nhọn ({}) để đánh dấu một phần của đường dẫn URL là có thể thay thế bằng cách sử dụng các tham số đường dẫn.
Đối với các tiêu chuẩn kết nối, OpenAPI tuân thủ RFC6838. Đối với mã trạng thái HTTP, nó được sử dụng để chỉ ra trạng thái của hoạt động được thực thi. Các mã trạng thái có sẵn được xác định bởi RFC7231 và các mã trạng thái đã đăng ký được liệt kê theo tổ chức cấp phát số hiệu chuẩn Internet (IANA).
1.3.2 Định nghĩa Swagger là gì?
Swagger là một công cụ có mã nguồn mở và dùng để xây dựng nên OpenAPI Specifications để có thể thiết kế, xây dựng tài liệu và sử dụng REST APIs.
Với các nhà phát triển, khi sử dụng Swagger sẽ được cung cấp 3 tool chính như sau: Tool Swagger Editor: được sử dụng để thiết kế, xây dựng nên các APIs một
cách mới hoàn toàn hoặc là có thể edit lại từ những APIs có sẵn với việc tận dụng một file config.
Tool Swagger Codegen: có tác dụng trong việc generate ra code thơng qua sử dụng các file config sẵn có trước đó.
Tool Swagger UI: ứng dụng trong việc generate các file ra HTML, CSS,... xuất phát từ một file config.
Để có thể thực hiện việc viết document cho Swagger thì các developers sẽ có 2 cách để tiếp cận với bộ mã nguồn mở này.
Cách 1: Top down approach: dùng để thiết kế nên các APIs trước khi thực hiện việc code liên quan.
Cách 2: Bottom down approach: dùng để mô tả các vấn đề, thông số liên quan API thông qua việc sử dụng thiết kế có sẵn của file config.
Với những tool được liệt kê ở trên của Swagger thì Swagger UI được biết đến là một tool có sự thơng dụng phổ biến nhất hiện nay. Với tool Swagger UI, tool này có ứng dụng rất lớn trong việc xây dựng giao diện cho các tài liệu bắt nguồn từ file config áp dụng dưới chuẩn Open API. Giao diện được tạo ra bởi tool này thường có tính tường minh và khá rõ ràng, hiện ra một cách cụ thể nhất cho các nhà phát triển. Điều này sẽ giúp ích rất lớn cho cả người dùng lẫn các lập trình viên trong việc đọc hiểu và sử dụng. Thêm vào đó, đây cũng là dẫn chứng cho việc các developers sử dụng file config nhưng lại có sự tách biệt một cách hồn tồn giữa các tác vụ với nhau.
Mỗi API được sử dụng trong quá trình này sẽ cho chúng ta biết một cách chính xác nhất về nguồn ra một cách chi tiết. Thêm vào đó chính là việc những trường cần phải được gửi lên hệ thống cũng như các trạng thái kết quả có thể được trả về. Điều đặc biệt nhất có lẽ chính là việc ta có thể đưa các dữ liệu vào trong để test thử các kết quả liệu có thực sự chính xác và đảm bảo tính đúng đắn hay khơng.
1.3.3 Cấu trúc cơ bản của Swagger.
1.3.3.1 Metadata hay Info
Hầu hết, mỗi Open API Specifications được sử dụng đều sẽ bắt đầu với từ khóa “Open API” nhằm mục đích cho việc khai báo tên của phiên bản đó. Với loại phiên bản được sử dụng sẽ có ý nghĩa trong việc định nghĩa lại toàn bộ những cấu trúc ở trong API. Phần Info sẽ có các thơng tin cơ bản về API như title, description và các version. Cụ thể thì:
Title sẽ là tên mà bạn đặt cho API của mình.
Description chính là các thơng tin về API của bạn được đưa ra một cách chi tiết và xuất hiện ở nhiều mặt cụ thể khác nhau. Với việc mơ tả này thì bạn hồn tồn có thể viết thành nhiều dịng nếu như dài quá và sử dụng cú pháp hỗ trợ như markdown.
Version là phiên bản được sử dụng trong quá trình tạo dựng của bạn với API. Metadata hay Info sẽ có chức năng trong việc hỗ trợ đưa ra các từ khóa về các thơng tin liên quan như thơng tin liên lạc, thông tin về chứng chỉ, các điều khoản trong việc sử dụng,...
1.3.3.2 Servers
Để có thể test được các API thì bạn cần có một đường dẫn liên quan đến servers. Và đây chính là phần tạo ra một đường dẫn cụ thể của servers được sử dụng để thực hiện chức năng trên. Trong phần này, việc định nghĩa hay là nhiều các servers khác nhau sẽ hoàn toàn tùy thuộc vào quyết định của bạn.
1.3.3.3 Paths
Được biết phần mấu chốt, trọng tâm của API được sử dụng. Với phần này, nhiệm vụ của những nhà lập trình viên chính là định nghĩa những paths xuất hiện trong API hay các phương thức, những tham số cụ thể tồn tại trong API đó.
Một vài lưu ý cần được chú ý như sau:
Việc bắt đầu sẽ cần phải bằng từ khóa “paths”.
Sau đó chính là các phương thức được sử dụng trong API như Get, Post, Delete,...
Phần mơ tả một cách tóm tắt, ngắn gọn của API: Summary.
Những tham số được đưa vào trong API gọi là parameters. Với phần này, lập trình viên có thể thực hiện set các tham số required, thực hiện việc mơ tả những tham số đó hoặc là validate cho chúng. Thêm vào đó, điều đặc biệt ở phần này chính là việc bạn có thể chỉ định một model bất kỳ nhằm mục đích định nghĩa cho những tham số đó.
Cuối cùng là phần trả về của server đó hay cịn được biết đến là response. Với phần trả về này thì bạn có thể thực hiện việc định nghĩa cho các HTTP code mà người dùng có thể nhận được như 200, 404,... kèm theo đó là những dịng mô tả xuất hiện với từng trường hợp cụ thể.
Thêm vào đó, ở phần này, các parameters sẽ sở hữu khá nhiều loại khai báo khác nhau đứng sau từ khóa”in” mà chúng ta đều cần phải lưu ý: (adsbygoogle = window.adsbygoogle || []).push({});
In body: giúp cho người dùng có một khơng gian để tạo ra một dữ liệu đầu vào. Ở khơng gian này, người dùng hồn tồn có thể nhập các dữ liệu về những yêu cầu cơ bản vào trong đó.
In formData: giúp cho người dùng tạo được input đã được xác định trước để có thể thực hiện nhập các dữ liệu yêu cầu theo từng miền đã được định sẵn. In path: sử dụng trong việc tạo lập một input vào trong giá trị để khai báo trong
các routers, thông thường được gọi là ID.
In query: được sử dụng trong việc tạo input nhập vào các giá trị thống kê theo các miền định sẵn để dùng trong việc gửi các query request.
In header: thực hiện dùng để khai báo các giá trị có trong header của yêu cầu mà bạn cần thực hiện truyền tải lên.
1.3.3.4 Schema
Trong hệ thống SQL Server, Schema mới bắt đầu được nhắc đến từ phiên bản 2005. Đó là một khơng gian tên được sử dụng để gom các table vào một nhóm, chúng có tác dụng để quản lý dễ dàng hơn. Nếu bạn khơng dùng Schema trong cơ sở dữ liệu, thì Schema lúc này sẽ được thay thế bởi một mặc định khác, đó là Dbo.
Chẳng hạn như có hai loại table chính trong lược đồ cơ sở dữ liệu như sau: thứ nhất là các table về tin tức, lúc này sẽ đặt tên cho Schema là “news”, trong đó gồm các table có bản chất nội dung là tin tức vào. Thứ hai là các table về hệ thống, lúc này sẽ đặt tên cho Schema là