WooCommerce Cat 外掛開發 (二) – 開發環境

目錄

前情提要:前篇文章檢視了數十間使用台灣開店服務的購物網站,從商品列表、商品介紹、購物車以及結帳頁來獲得目前主流的結帳流程與介面的設計模式,以作為日後開發參考。

收集完設計參考資料後,接下來開始來寫程式吧!在動工前先來介紹我自己常用的開發工具,分別就本機環境建立、前端打包工具與前端框架來說明這一支外掛會用到哪些技術,其中不少工具都是好幾年前就在用的,還能被我用到現在代表他們經得起時間考驗。

一、建立 WordPress 本機環境 ValetPress

現在市面上有非常多免費軟體可以透過使用者介面在本機建立 WordPress 網站,而我最慣用的還是提供給 PHP 框架 Laravel 使用的 Valet,它是一套專門給 MacOS 使用的指令工具,它會自動使用本機內已經安裝好的 PHP、Nginx、MySQL 來作為架站環境,雖然安裝比較麻煩,但是可以所有站共用一套環境能很大程度減低本機的負擔。

因為 WP 跟 Laravel 需要的環境基本上差不多,因此就有大大寫了 ValetPress 透過 WP-CLI 建立 WordPress 網站,而指令碼的內容也非常容易理解,修修改改就可以滿足自己的需求,下面是我用它在本機建立一個 WP 站並安裝好 WooCommerce 與 Storefront 的流程:

https://oberonlai.blog/wp-content/uploads/woocommerce-cat-2/woocommerce-cat-01.gif

大概一分鐘左右就可以搞定整個流程,不僅外掛連佈景主題都會自動完成安裝並啟用,而且還能匯入 demo data 就不用自己再手動建立商品與文章,最重要的是用這種方式建立的本機 WordPress 速度非常快,前後台都可以秒換頁,比使用虛擬機的效果好上太多,在開發時使用 Broswer Sync 或是 Auto reload 的爽度非常有感。

我的 WooCommerce 測試站建立指令如下:

cd ~/Users/Sites
echo "${VP_BOLD}ValetPress, create empty new site with WooCommerce${VP_NONE}"
echo "${VP_YELLOW}Project Name:${VP_NONE}"
read project_name
mkdir "$project_name"
cd "$project_name"
mysql -uroot -e "create database \`$project_name\`"
wp core download --locale=zh_TW --skip-content
wp core config --dbname="$project_name" --dbuser=root --dbhost=127.0.0.1
wp core install --url="$project_name".test --title="$project_name".test --admin_user="$project_name"  --admin_password=password --admin_email=wordpress@wordpress.org
wp language core install zh_TW
wp language core activate zh_TW
wp option update timezone_string "Asia/Taipei"
wp site switch-language zh_TW
echo "${VP_GREEN}Success:${VP_NONE} Project Created: ${VP_UNDERLINE}https://$project_name.test/${VP_NONE}"
wp plugin install woocommerce
wp language plugin install woocommerce zh_TW
wp plugin activate woocommerce
wp theme install storefront
wp language theme install storefront zh_TW
wp theme activate storefront
wp plugin install wordpress-importer --activate
wp import dummy-data.xml --authors=skip
echo "Valet Link Project"
cd ~/Users/Sites/"$project_name"/
valet link $project_name
valet secure $project_name
echo "L: ${VP_UNDERLINE}https://$project_name.test/wp-admin/${VP_NONE}"
echo "U: $project_name"
echo "P: password"

如果想要做更多事去查 WP-CLI 的用法加進去即可,如果你是使用 MacOS 且對這樣的使用方式很有興趣,可以參考這篇文章:https://oberonlai.blog/valetpress-setup/

二、前端打包工具 Wpackio

由於 WooCommerce Cat 這支外掛會用到大量的新版 JavaScript,而且可預期程式碼會非常複雜需要進行拆分,因此我們會用到打包工具來處理 JavaScript 的轉譯與壓縮等各種功能,這邊我用的是之前電子報有介紹過的工具 wpack.io,雖然開發者已經沒在維護了,但用在幾個專案中都沒出過任何問題。

安裝方式也非常簡單,將目錄切換到外掛資料夾底下,先透過 NPM 執行的安裝:npx @wpackio/cli 再,再執行 bootrstrap 來建立設定檔範本:npm run bootstrap,就會有一連串的互動式選項來選擇你需要的工具:

https://oberonlai.blog/wp-content/uploads/woocommerce-cat-2/woocommerce-cat-03.jpg

完整的安裝步驟可以參考官方文件或是我之前的文章:https://oberonlai.blog/wordpress-plugin-webpack/

在我自己用它實戰後比較需要注意的地方有幾個,首先是 wpackio.project.js 設定裡面的 slug 參數務必要用外掛的資料夾名稱,我之前誤以為它會抓外掛的 Text Domain,以這支外掛為例,woocommerce-cat 有點太長了,所以我將 Text Domain 命名為 woocat,然後 wpackio 設定我也改用這個名字結果噴錯。

由於在執行階段它會以 woocommerce-cat 去設定路徑來載入對應的前端檔案,因此找不到 wp-content/plugins/woocat 就會發生 JS 檔無法載入的錯誤訊息,而且這個訊息從 console 是找不到的,害我卡了非常久的關一度打算要棄守這個套件。

另一個要注意的是如果你習慣用自動重整瀏覽器,記得要在設定檔設定 watch 的檔案:

https://oberonlai.blog/wp-content/uploads/woocommerce-cat-2/woocommerce-cat-04.jpg

然後最恐怖最致命最令我不願回想起的大雷就是打包功能,packageDirPath 參數設定要小心,它會先確認目標路徑是否有存在的檔案,有的話就會先清除既有的所有檔案後再來執行打包動作,如果要用記得絕對不要把路徑設成「/」,不然就會像我一樣把外掛主程式全部刪除而且完全救不回來。

三、JavaScript 框架 Alpine.js

https://oberonlai.blog/wp-content/uploads/woocommerce-cat-2/woocommerce-cat-06.jpg

一直沒機會專文介紹我最愛的 JS 框架 Alpine.js,跟前三大框架比起來它非常的輕巧,整體容量不到 40 KB,但對我來說它的輕巧不只是容量,而是引入即用的特性才是吸引我的最大優點,它不像一般框架要做很多編譯的設定,甚至因為設定太複雜還要推出指令工具來簡化設定流程。

Alpine.js 只要一行引入就可以開始用,完全不用煩惱設定問題,而寫法上比較偏向我之前學習過的 Vue.js,所以用起來完全是無縫接軌,一開始我只用在幾個小專案裡面,最近用在比較複雜的專案上發現到也是非常夠用,尤其是這種非全部由 JS 產 DOM 中間會夾帶 PHP 的 WordPress 外掛開發特別適合。

另外 Alpine.js 的社群也滿活躍的,官方也有推出付費元件來整合第三方套件像是 Chart.js、Select2、FullCalendar 等等,同時也有不少的第三方外掛來擴充它的功能,很希望它可以活得長長久久並且持續進化。

為了更有效的拆分前端程式碼我目前預計的結構如下:

https://oberonlai.blog/wp-content/uploads/woocommerce-cat-2/woocommerce-cat-08.jpg

dist 是 wpackio 打包編譯後的檔案,src 則是我們的未編譯的前端程式碼,我把對應到四個 WordPress 短碼的 JS 拆成四個檔案,然後透過 main.js 引入並交由 Alpine.js 來進行初始化,等開始實作後這樣的架構應該還會再做調整。

https://oberonlai.blog/wp-content/uploads/woocommerce-cat-2/woocommerce-cat-09.jpg

監聽 Alpine.js 專用的 alpine:init 事件就能在初始化時載入對應的檔案,它跟其他框架一樣會先需要在 HTML 中定義它的守備範圍,也就是在這範圍內可以透過 Apline.js 來動態產生 DOM,還可以做判斷式、迴圈等等的操作,具體實作的部分可以參考官方文件,我也會在接下來的文章利用 Alpine.js 來示範如何開發出前後端混搭的 WordPress 外掛。

四、Master CSS 框架

https://oberonlai.blog/wp-content/uploads/woocommerce-cat-2/woocommerce-cat-07.jpg

對於把 CSS 寫在 HTML 裡面這件事我的接受度很高,從 Tailwind CSS 開始我就完全接納了這樣的作法,今年又接觸到由台灣團隊開發的 Master CSS 更是驚為天人,完全不用背 class 的寫法對於早已熟悉 CSS 的我更是如魚得水,我熱愛這套框架愛到還幫他們開發 WordPress 免費外掛,現在每個專案已經不能沒有它。

就像 Alpine.js 一樣,引入後就能使用,整體體積也是小到不可思議的 14 KB,相比 Tailwind CSS 整包未清除前的 470 KB,不用去處理沒用到的內建樣式是我會採用 Master CSS 的主要原因,畢竟 Tailwind CSS 還是要多一道編譯的動作來進行瘦身。

Master CSS 更強大的地方是可以自己設計一套 class 命名規則來把常用的樣式整合起來,這就像是你可以用它做一套自己的 Bootstrap 一樣,把寫過的樣式拿來重用,而我實戰後發現它與 Alpine.js 的相容性也很高,不會因為是動態產生的 DOM 而吃不到樣式。

Master CSS 與 Alpine.js 具體寫起來會長成這樣:

https://oberonlai.blog/wp-content/uploads/woocommerce-cat-2/woocommerce-cat-05.jpg

Master CSS 可以直接在 class 裡面選到子元素來寫樣式,<template> 的部分則是 Alpine.js 的迴圈用法,使用 x-bind 綁定 class 來動態產生 CSS,我就可以非常直觀的看出這個清單大概會是長什麼樣,要修改清單的樣式也非常容易且快速。

小結

備妥開發環境之後接下來就要來實作外掛,我預計會先開始結帳頁的前端設計,因為它最複雜且牽涉到的資料最多,光是用想的就知道有一卡車的問題需要解決,總之先從快樂的 CSS 開始吧XD,我們下週見!

目錄

賴俊吾 / Oberon Lai
賴俊吾 / Oberon Lai

現為全職 WordPress 工程師,網站開發經歷 11 年,專攻前端工程與 WordPress 佈景主題、外掛客製化開發

訂閱電子報

Hi,我是 Oberon,我會固定在每週五早上發送接案心得以及與 WordPress 相關的電子報,同時也會分享一些實用的開發知識,讓你在 WordPress 的接案路上不孤單!

覺得文章寫得好再幫我鼓個掌吧!

相關文章

WooCommerce Cat 外掛開發 (五) – 修改購物車

前情提要:上一篇我們實作了 Alpine.js 的迴圈,也認識了 x-bind 綁定屬性、x-text/x-html 輸出文字,以...

WooCommerce Cat 外掛開發 (四) – 顯示購物車

前情提要:上一篇我們實作了加入購物車的 API,並且認識了 Alpine.js 的基本使用方式,接下來我們要深入購物車表格,讓它可...

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。

這個網站採用 Akismet 服務減少垃圾留言。進一步了解 Akismet 如何處理網站訪客的留言資料

專注於分享 WordPress 開發、接案技巧、專案管理等自由工作者必備知識與心得

© 2022 想點創意科技有限公司

Designed by Hend Design | 隱私權政策

訂閱電子報

Hi,我是 Oberon,我會固定在每週五早上發送接案心得以及與 WordPress 相關的電子報,同時也會分享一些實用的開發知識,讓你在 WordPress 的接案路上不孤單!