Tạo một plugin
Cập nhật lúc 1742653605000Cài đặt ezyplatform
Bạn có thể xem hướng dẫn cài đặt tại đây.
Hướng dẫn cài đặt ezyplatform SDK
- Tải ezyplatform SDK từ trang chủ.
- Giải nén file vừa tải về, ví dụ đường dẫn giải nén:
app/ezyplatform-sdk
. - Thiết lập biến môi trường
EZYPLATFORM_SDK
trỏ đến thư mục vừa giải nén:
export EZYPLATFORM_SDK=app/ezyplatform-sdk
- Thêm thư mục
bin
của SDK vào biếnPATH
để sử dụng công cụezy.sh
:
export PATH=$PATH:$EZYPLATFORM_SDK/bin
Ví dụ trên Linux:
Mở file cấu hình bằng lệnh:
nano ~/.bash_profile
Thêm các dòng sau vào file:
export EZYPLATFORM_SDK=app/ezyplatform-sdk export PATH=$PATH:$EZYPLATFORM_SDK/bin
Lưu và áp dụng thay đổi:
source ~/.bash_profile
Ví dụ trên Windows:
- Mở
Control Panel → System and Security → System
. - Chọn
Advanced system settings → Environment Variables
. - Trong phần
System variables
, bấmNew
để thêm biến mới:
- Variable name:
EZYPLATFORM_SDK
- Variable value:
C:/path/to/app/ezyplatform-sdk
- Tìm biến
Path
trong danh sáchSystem variables
, bấmEdit
. - Thêm đường dẫn vào thư mục
bin
của SDK:
%EZYPLATFORM_SDK%/bin
- Bấm
OK
để lưu lại.
Build các thư viện cần thiết
Hãy đảm bảo rằng bạn đã cài đặt apache maven trước đó.
- Clone ezyplatform-development về.
- Di chuyển đến thư mục ezyplatform-development vừa clone và chaỵ lệnh:
bash build.sh
hoặc.\build.bat
đối với windows.
Tạo plugin project
- Di chuyển đế thực mục chứa các dự án của bạn.
- Bạn có thể chạy lệnh:
ezy.sh -h
hoặcezy.bat -h
đối với windows và sẽ thấy hướng dẫn tạo project như sau:
create, create-project, cp, -cp <project name> -g <group name, example: com.your_company> -p [package name, example: com.your_company.my_project] -v [version, example: 1.0.0] -i [inclusive modules: *,admin-plugin,socket-app,socket-plugin,theme,web-plugin] -e [exclusive modules: admin-plugin,socket-app,socket-plugin,theme,web-plugin] -a [author] -o [output directory]: to create a project
Giả sử bạn cần tạo dự án hello-word
với 3 loại module là admin-plugin
, theme
và web-plugin
và groupId là com.example
bạn có thể chạy lệnh:
ezy.sh cp hello-world -g com.example -i admin-plugin,theme,web-plugin
ezy.bat cp hello-world -g com.example -i admin-plugin,theme,web-plugin
Chạy plugin project
Hãy chắc chắn rằng bạn đang sử dụng Java 8.
Ví dụ bạn vừa tạo dự án có tên hello-world
.
- Di chuyển vào thư mục hello-world.
- Import dự án hello-world vào IntelliJ IDE, lưu ý nếu intelliJ của bạn không nhận
EZYPLATFORM_HOME
path variable, bạn sẽ cần làm theo hướng dẫn sau: Khắc phục lỗi IntelliJ không nhận path variable. - Chạy lệnh:
bash export.sh
để export các thành phần của dự án đếnEZYPLATFORM_HOME
. - Tìm đến file
HelloWorldAdminPluginStartupTest
trong modulehello-world-admin-plugin
trong thư mụcsrc/test/[tên gói]/
. - Chạy file này.
- Mở trình duyệt, truy cập vào đường dẫn: htpp://localhost:9090 đây chính là giao diện admin.
- Trong giao diện admin, duy chuyển đến
Plugins/Admin
, tìm đến hello-world plugin và active nó lên. - Khởi động lại
HelloWorldAdminPluginStartupTest
. - Ngoài ra nếu bạn muốn khởi động
socket-app
,socket-plugin
,theme
,web-plugin
hãy tìm đến các lớpXxxStartupTest
trong các thư mục tương ứng.
Cấu hình lại working directory trên IntelliJ
Mặc định thì intelliJ sẽ có working directory là thư mục root ví dụ hello-world
. Tuy nhiên để ezyplatform-tools có thể tự động load lại các file html, css, javascript hay các file static khác thì chúng ta sẽ cần chỉ định working directory về đúng module đang chạy.
- Trên intelliJ ở phần run, lựa chọn Edit Configurations…
- Trong phần Working directory cần trỏ về module tương ứng với file XxxStartupTest mà bạn cần khởi động.
Nếu IntelliJ không ghi nhận được path variable, bạn có thể tham khảo tại đây để tìm cách xử lý.
Export plugin
Để có thể publish plugin lên chợ ezyplatform.com hoặc cài đặt plugin cho ezyplatform trên máy chủ của bạn, bạn sẽ cần di chuyển đến dự án plugin của bạn ví dụ là hello-world
, sau đó export bằng câu lệnh bash export.sh
với linux và export.bat
với windows.
Hãy em logs và đảm bảo rằng không có lỗi gì được ném ra, sau đó bạn sẽ có được file zip tại thư mục hello-world/target/project/hello-world.zip
. Bạn có thể sử dụng file zip này để publish hoặc cài đặt.
Build lại plugin với IntelliJ IDE
Sau khi export plugin bạn cần build lại plugin bằng cách nhấn vào nút install
bên phía tay phải của IntelliJ IDE để có thể start plugin với IDE. Tôi không biết tại sao, có thể đây là một bug của IntelliJ.

Thay đổi working directory
Mặc định thì IntelliJ sẽ chạy dự án với thư mục gốc, bạn sẽ cần thay đổi Working directory
sang các module tương ứng thì mới có thể sử dụng được tính năng tự động reload của ezyplatform-devtools. Giả sử bạn đang cần chạy HelloWorldAdminPluginStartupTest
của module bạn sẽ cần thay đổi Working directory
như sau:

Tiếp theo
Bạn có thể liên kết với các plugin có sẵn để tái sử dụng lại các tính năng và mã nguồn.