何成為 QueryPHP 開發(fā)者

bigdevil_s 發(fā)布于2019-07-01 12:51 / 668人閱讀

摘要：文檔開發(fā)基于單元測試實現(xiàn)的自動化文檔當(dāng)前文檔開發(fā)計劃功能開發(fā)當(dāng)前計劃功能技術(shù)債務(wù)清償當(dāng)前技術(shù)債務(wù)單元測試盡可能減少當(dāng)前單元測試成為開發(fā)者需要加入我們的組織，如有相關(guān)意愿請發(fā)送郵件至小牛哥，我們會聯(lián)系你的。

QueryPHP 非常歡迎各位給我們共同的偉大的作品添磚加瓦，實現(xiàn)為 PHP 社區(qū)提供一個好框架的美好愿景。

文檔開發(fā).基于單元測試實現(xiàn)的自動化文檔當(dāng)前文檔開發(fā)

計劃功能.開發(fā) 當(dāng)前計劃功能

技術(shù)債務(wù).清償當(dāng)前技術(shù)債務(wù)

單元測試.盡可能減少 Bug 當(dāng)前單元測試

成為開發(fā)者需要加入我們的組織，如有相關(guān)意愿請發(fā)送郵件至 小牛哥 <[email protected]>，我們會聯(lián)系你的。

成為開發(fā)者并沒有什么任務(wù)負擔(dān)，一切主要以你的意愿，興趣才是最重要的。

本篇指南將帶你搭建的 QueryPHP 開發(fā)框架的開發(fā)環(huán)境，使得你可以參與 QueryPHP 底層代碼、單元測試和文檔等開發(fā)工作。

這里以筆者的 Mac 為例子說明，其實 Windows 下面還更簡單些。

克隆 queryphp 倉庫

QueryPHP 框架的開發(fā)來自于從克隆主倉庫開始，由于國內(nèi)訪問 Github 網(wǎng)速的問題，只需要等待一小段時間。

下載代碼

$cd /data/codes/test
$git clone [email protected]:hunzhiwange/queryphp.git

Composer 安裝

composer install

如果你電腦沒有安裝 composer，那么已經(jīng)為你下載一個版本。

sudo chmod 777 ./build/composer
./build/composer install

安裝過程

Cloning into "queryphp"...
remote: Enumerating objects: 54, done.
remote: Counting objects: 100% (54/54), done.
remote: Compressing objects: 100% (39/39), done.
remote: Total 17821 (delta 19), reused 36 (delta 14), pack-reused 17767
Receiving objects: 100% (17821/17821), 45.12 MiB | 693.00 KiB/s, done.
Resolving deltas: 100% (8700/8700), done.

測試是否安裝成功

如果可以訪問，那么恭喜你第一階段即安裝完畢。

標(biāo)準后臺 API 端

首先我們需要創(chuàng)建一個數(shù)據(jù)庫來運行我們的后臺，讓我們對 QueryPHP 有一個直觀的感受，同時方便后期開發(fā)調(diào)試等。

首先創(chuàng)建一個數(shù)據(jù)庫

可以用 Navicat For Mysql 創(chuàng)建一個數(shù)據(jù)庫 queryphp_development_db.

CREATE DATABASE IF NOT EXISTS queryphp_development_db DEFAULT CHARSET utf8 COLLATE utf8_general_ci;

修改 .env

...
// Database
DATABASE_DRIVER = mysql
DATABASE_HOST = 127.0.0.1
DATABASE_PORT = 3306
DATABASE_NAME = queryphp_development_db
DATABASE_USER = root
DATABASE_PASSWORD =
...


修改為


...
// Database
DATABASE_DRIVER = mysql
DATABASE_HOST = 127.0.0.1
DATABASE_PORT = 3306
DATABASE_NAME = queryphp_development_db
DATABASE_USER = root
DATABASE_PASSWORD = 123456
...

執(zhí)行數(shù)據(jù)庫遷移命令

php leevel migrate:migrate

安裝過程

using config file ./phinx.php
using config parser php
using migration paths
- /data/codes/test/queryphp/database/migrations
using seed paths
- /data/codes/test/queryphp/database/seeds
warning no environment specified, defaulting to: development
using adapter mysql
using database queryphp_development_db


== 20181109060739 App: migrating
== 20181109060739 App: migrated 0.0155s


== 20181112023649 Role: migrating
== 20181112023649 Role: migrated 0.0160s


== 20181112024140 User: migrating
== 20181112024140 User: migrated 0.0166s


== 20181112024211 Permission: migrating
== 20181112024211 Permission: migrated 0.0225s


== 20181112024241 UserRole: migrating
== 20181112024241 UserRole: migrated 0.0155s


== 20181112024302 RolePermission: migrating
== 20181112024302 RolePermission: migrated 0.0206s


== 20181112024416 Resource: migrating
== 20181112024416 Resource: migrated 0.0328s


== 20181112024450 PermissionResource: migrating
== 20181112024450 PermissionResource: migrated 0.0305s


== 20181203130724 Option: migrating
== 20181203130724 Option: migrated 0.0170s


== 20181203144731 Test: migrating
== 20181203144731 Test: migrated 0.0133s


All Done. Took 0.2273s

測試數(shù)據(jù)庫是否正常

php leevel server

結(jié)果

{
    count: 4,
    :trace: {
        ...
    }
}

標(biāo)準后臺前端端

后臺 API 搭建好了，我們開始搭建前端了，前端基于 Vue-cli 3 和 IView，首先需要安裝 node 才能夠跑起來。

對于開發(fā) QueryPHP 來說，你不需要會 Vue 或者 JavaScript，所以請放心不要有心里負擔(dān)。

安裝前端

第一步安裝前端,細節(jié)信息可以在 frontend/README.md 查看.

cd frontend
npm install -g cnpm --registry=https://registry.npm.taobao.org // Just once
cnpm install

安裝過程

? All packages installed (1264 packages installed from npm registry, used 14s(network 13s), speed 221.08kB/s, json 1086(2.23MB), tarball 501.92kB)

運行前端

接著訪問這個登陸地址.

npm run serve # npm run dev

輸入登陸用戶名和密碼,這個時候 QueryPHP 不再是一個冰冷的代碼，而是有一個干凈的帶有基礎(chǔ)權(quán)限系統(tǒng)的后臺。

user: admin
password: 123456

運行測試用例

QueryPHP 推崇通過編寫測試用例來讓代碼變得可維護，所以這里需要本地開發(fā)跑通測試用例。

首先創(chuàng)建一個數(shù)據(jù)庫

可以用 Navicat For Mysql 創(chuàng)建一個數(shù)據(jù)庫 queryphp_development_test.

CREATE DATABASE IF NOT EXISTS queryphp_development_test DEFAULT CHARSET utf8 COLLATE utf8_general_ci;

修改 .env

...
// Database
DATABASE_DRIVER = mysql
DATABASE_HOST = 127.0.0.1
DATABASE_PORT = 3306
DATABASE_NAME = test
DATABASE_USER = root
DATABASE_PASSWORD =
...


修改為


...
// Database
DATABASE_DRIVER = mysql
DATABASE_HOST = 127.0.0.1
DATABASE_PORT = 3306
DATABASE_NAME = queryphp_development_test
DATABASE_USER = root
DATABASE_PASSWORD = 123456
...

執(zhí)行數(shù)據(jù)庫遷移命令

php leevel migrate:migrate -e testing

安裝過程

using config file ./phinx.php
using config parser php
using migration paths
- /data/codes/test/queryphp/database/migrations
using seed paths
- /data/codes/test/queryphp/database/seeds
using environment testing
using adapter mysql
using database queryphp_development_test


== 20181109060739 App: migrating
== 20181109060739 App: migrated 0.0155s


== 20181112023649 Role: migrating
== 20181112023649 Role: migrated 0.0160s


== 20181112024140 User: migrating
== 20181112024140 User: migrated 0.0166s


== 20181112024211 Permission: migrating
== 20181112024211 Permission: migrated 0.0225s


== 20181112024241 UserRole: migrating
== 20181112024241 UserRole: migrated 0.0155s


== 20181112024302 RolePermission: migrating
== 20181112024302 RolePermission: migrated 0.0206s


== 20181112024416 Resource: migrating
== 20181112024416 Resource: migrated 0.0328s


== 20181112024450 PermissionResource: migrating
== 20181112024450 PermissionResource: migrated 0.0305s


== 20181203130724 Option: migrating
== 20181203130724 Option: migrated 0.0170s


== 20181203144731 Test: migrating
== 20181203144731 Test: migrated 0.0133s


All Done. Took 0.2273s

運行測試用例

php ./build/phpunit

結(jié)果

注意隨著系統(tǒng)演進，測試用例會增加，輸出結(jié)果就有所不同。

PHPUnit Pretty Result Printer 0.26.2 by Codedungeon and contributors.
PHPUnit 8.1.3 by Sebastian Bergmann and contributors.


==> TestsAdminServiceResourceIndexTest       ?  ?
==> TestsExampleExampleTest                    ?
==> TestsExamplePHPUnitTest                    ?
==> CommonDomainServiceSearchIndexTest       ?  ?  ?  ?  ?  ?
==> CommonInfraHelperArrayToFormTest          ?  ?  ?  ?  ?  ?
==> CommonInfraSupportWorkflowServiceTest     ?  ?  ?  ?  ?
==> CommonInfraSupportWorkflowTest            ?  ?  ?  ?  ?

Time: 391 ms, Memory: 18.00 MB

OK (26 tests, 43 assertions)

統(tǒng)一團隊代碼風(fēng)格

風(fēng)格統(tǒng)一對保證我們系統(tǒng)一致性非常重要，我們做到開箱即用，支持 PHP 和 JavaScript。

使用 Git 鉤子

cp ./build/pre-commit.sh ./.git/hooks/pre-commit
chmod 777 ./.git/hooks/pre-commit

測試自動化格式

common/Test.php


frontend/src/hello.js
function hello(a,b) {
    var c
        if(a>b) {
            c=a
        } else {
            c=b
        }
    console.log(c)
}
Git 提交測試格式化
git add .
git commit -m "測試格式化"
運行過程
Checking PHP Lint...
No syntax errors detected in common/Test.php
Running Code Sniffer...
Loaded config default from ".php_cs.dist".
Paths from configuration file have been overridden by paths provided as command arguments.
1) common/Test.php Fixed all files in 0.009 seconds, 12.000 MB memory used
The file has been automatically formatted.
[13:04:00] Working directory changed to /data/codes/test/queryphp/frontend
[13:04:00] Using gulpfile /data/codes/test/queryphp/frontend/gulpfile.js
[13:04:00] Starting "iview"...
[13:04:00] Finished "iview" after 413 μs
frontend/src/hello.js 53ms
[master 681d7e29] 測試格式化
3 files changed, 32 insertions(+)
mode change 100644 => 100755 build/composer
create mode 100644 common/Test.php
create mode 100644 frontend/src/hello.js
格式化后的 PHP
代碼干凈漂亮了不少，不是嗎。

格式化后的 JavaScript
代碼干凈漂亮了不少，不是嗎。
function hello(a, b) {
    var c
    if (a > b) {
        c = a
    } else {
        c = b
    }
    console.log(c)
}
回滾測試提交
這些測試代碼不需要提交到 Git 庫，你可以回滾掉剛才測試的這些代碼。
git log
git reset --hard 931f283b0b8847e4a3f2ad86efb3c07cd7974c3b // 或者 git revert xxx
HEAD is now at 931f283b Merge branch "dev"
克隆 framework 倉庫將框架替換為開發(fā)版本
應(yīng)用層框架全部搭建完畢，接下來我們將框架層代碼替換為開發(fā)階段的代碼來進行日常框架迭代。
刪除框架層
rm -rf ./vendor/hunzhiwange/framework
克隆框架層開發(fā)庫
$cd /data/codes/test
$git clone [email protected]:hunzhiwange/framework.git ./vendor/hunzhiwange/framework
cd ./vendor/hunzhiwange/framework
Composer 安裝
composer install
如果你電腦沒有安裝 composer，那么已經(jīng)為你下載一個版本。
sudo chmod 777 ./build/composer
./build/composer install
安裝過程
Cloning into "./vendor/hunzhiwange/framework"...
remote: Enumerating objects: 382, done.
remote: Counting objects: 100% (382/382), done.
remote: Compressing objects: 100% (218/218), done.
remote: Total 39304 (delta 196), reused 262 (delta 125), pack-reused 38922
Receiving objects: 100% (39304/39304), 14.49 MiB | 12.00 KiB/s, done.
Resolving deltas: 100% (27594/27594), done.
測試是否安裝成功
從新訪問首頁，如果可以訪問，那么恭喜你第一階段即安裝完畢。
php leevel server 
運行框架核心測試用例
QueryPHP 底層框架擁有 3000 多例測試用例，這些測試用例需要被維護，所以這里需要本地開發(fā)跑通測試用例。首先創(chuàng)建一個數(shù)據(jù)庫
可以用 Navicat For Mysql 創(chuàng)建一個數(shù)據(jù)庫 test.
CREATE DATABASE IF NOT EXISTS test DEFAULT CHARSET utf8 COLLATE utf8_general_ci;
復(fù)制一份配置文件并修改
cp ./tests/config.php ./tests/config.local.php
修改為
 "127.0.0.1",
    "PORT"     => 3306,
    "NAME"     => "test",
    "USER"     => "root",
    "PASSWORD" => "123456",
];


$GLOBALS["LEEVEL_ENV"]["CACHE"]["REDIS"] = [
    "HOST"     => "127.0.0.1",
    "PORT"     => 6380,
    "PASSWORD" => "123456",
];


$GLOBALS["LEEVEL_ENV"]["SESSION"]["REDIS"] = [
    "HOST"     => "127.0.0.1",
    "PORT"     => 6380,
    "PASSWORD" => "123456",
];
執(zhí)行數(shù)據(jù)庫遷移命令
php vendor/bin/phinx migrate
安裝過程
Phinx by CakePHP - https://phinx.org. 0.9.2


using config file ./phinx.php
using config parser php
using migration paths
 - /data/codes/test/queryphp/vendor/hunzhiwange/framework/tests/assert/database/migrations
using seed paths
 - /data/codes/test/queryphp/vendor/hunzhiwange/framework/tests/assert/database/seeds
warning no environment specified, defaulting to: development
using adapter mysql
using database test


 == 20181010111946 User: migrating
 == 20181010111946 User: migrated 0.0076s


 == 20181011111926 Post: migrating
 == 20181011111926 Post: migrated 0.0101s


 == 20181011111937 Comment: migrating
 == 20181011111937 Comment: migrated 0.0106s


 == 20181011151247 PostContent: migrating
 == 20181011151247 PostContent: migrated 0.0087s


 == 20181011160957 Role: migrating
 == 20181011160957 Role: migrated 0.0078s


 == 20181011161035 UserRole: migrating
 == 20181011161035 UserRole: migrated 0.0100s


 == 20181031094608 CompositeId: migrating
 == 20181031094608 CompositeId: migrated 0.0094s


 == 20181107044153 GuestBook: migrating
 == 20181107044153 GuestBook: migrated 0.0086s


 == 20190424055915 TestUnique: migrating
 == 20190424055915 TestUnique: migrated 0.0133s


All Done. Took 0.1179s
運行測試用例
php ./build/phpunit
結(jié)果
注意隨著系統(tǒng)演進，測試用例會增加，輸出結(jié)果就有所不同。
PHPUnit 8.1.3 by Sebastian Bergmann and contributors.


==> TestsAuthHashTest                          ?  ?
==> TestsAuthManagerTest                       ?  ?  ?
==> TestsAuthMiddlewareAuthTest               ?  ?
==> TestsAuthProviderRegisterTest             ?
==> TestsAuthSessionTest                       ?  ?

...

==> TestsViewCompilerCompilerWhileTest        ?  ?
==> TestsViewHtmlTest                          ?  ?  ?  ?  ?  ?  ?  ?  ?
==> TestsViewManagerTest                       ?
==> TestsViewPhpuiTest                         ?  ?  ?  ?  ?  ?  ?  ?
==> TestsViewProviderRegisterTest             ?

Time: 19.51 seconds, Memory: 93.19 MB

Tests: 2978, Assertions: 10031, Failures: 0, Skipped: 6.
統(tǒng)一框架核心團隊代碼風(fēng)格
風(fēng)格統(tǒng)一對保證我們系統(tǒng)一致性非常重要，我們做到開箱即用，核心庫只包含 PHP 文件。
使用 Git 鉤子
cp ./build/pre-commit.sh ./.git/hooks/pre-commit
chmod 777 ./.git/hooks/pre-commit
測試自動化格式
tests/Name.php

Git 提交測試格式化
git add .
git commit -m "測試格式化"
運行過程
Checking PHP Lint...
No syntax errors detected in tests/Name.php
Running Code Sniffer...
Loaded config default from ".php_cs.dist".
Paths from configuration file have been overridden by paths provided as command arguments.
1) tests/Name.php Fixed all files in 0.009 seconds, 12.000 MB memory used
The file has been automatically formatted.
[master 20f2f845] 測試格式化
2 files changed, 29 insertions(+)
mode change 100644 => 100755 build/composer
create mode 100644 tests/Name.php
格式化后的 PHP
代碼干凈漂亮了不少，不是嗎。
測試代碼回滾請見上面的方法，謝謝。

* (c) 2010-2019 http://queryphp.com All rights reserved.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Test;

class Name
{
    public function demo($a = 1, $b = 4)
    {
        echo 1;
    }
}
克隆 queryphp.com 倉庫實現(xiàn)自動化文檔搭建
QueryPHP 底層的文檔基于單元測試加備注的方式來實現(xiàn)的，通過命名工具全部采用自動化生成 Markdown，這大幅度簡化了文檔的編寫工作，同時保證了文檔實時性。
官方文檔采用 VuePress 讀取 Markdown 來實現(xiàn)的
$cd /data/codes/test
$git clone [email protected]:hunzhiwange/queryphp.com.git
修改文檔工具生成 Markdown 的路徑
$cd /data/codes/test/queryphp
$vim .env


# 修改路徑
FRAMEWORK_DOC_OUTPUTDIR = "/data/codes/test/queryphp.com/docs/docs/"
生成文檔
$cd /data/codes/test/queryphp
$php leevel make:docwithin tests
運行過程
Class TestsEncryptionEncryptionTest was generate succeed.
Class TestsEncryptionSafeTest was generate succeed.
Class TestsDatabaseManagerTest was generate succeed.
Class TestsDatabaseDddUnitOfWorkTest was generate succeed.
Class TestsDatabaseDddCreateCreateTest was generate succeed.
Class TestsDatabaseQueryAggregateTest was generate succeed.
Class TestsValidateAssertTest was generate succeed.
Class TestsDiContainerTest was generate succeed.
Class TestsDocsBecomeAQueryphpDeveloperDoc was generate succeed.
Class TestsSupportFnTest was generate succeed.
Class TestsSupportStrTest was generate succeed.
Class TestsSupportArrTest was generate succeed.
Class TestsViewSummaryDoc was generate succeed.
Class TestsViewCompilerCompilerAssignTest was generate succeed.
Class TestsViewCompilerCompilerPhpTest was generate succeed.
Class TestsViewCompilerCompilerBreakTest was generate succeed.
Class TestsViewCompilerCompilerIncludeTest was generate succeed.
Class TestsViewCompilerCompilerTagselfTest was generate succeed.
Class TestsViewCompilerCompilerWhileTest was generate succeed.
Class TestsViewCompilerCompilerCssTest was generate succeed.
Class TestsViewCompilerCompilerForTest was generate succeed.
Class TestsViewCompilerCompilerVarTest was generate succeed.
Class TestsViewCompilerCompilerListTest was generate succeed.
Class TestsDebugDebugTest was generate succeed.
A total of 24 files generate succeed.
修改文檔菜單
$vim docs/.vuepress/config.js
運行本地文檔網(wǎng)站
訪問地址 localhost:8088 即可。
$npm install -g yarn
$yarn add -D vuepress # or npm install -D vuepress
$yarn run dev # or npx vuepress dev docs
結(jié)尾
到這里為止，我們本地開發(fā)環(huán)境已經(jīng)全部搭建完畢，可以愉快地開發(fā)了。
::: tip
值得注意的是，我們通常在 dev 分支開發(fā)，開發(fā)完畢后 merge 到 master 分支完成開發(fā)。
:::

文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/31630.html

發(fā)表評論

登陸后可評論

0條評論

bigdevil_s

男|高級講師

我要關(guān)注我要私信

TA的文章

1

閱讀 3808·2021-11-23 09:51
關(guān)于安裝wireshark中npcap一直無法安裝以及winpcap無法安裝解決方法

閱讀 4488·2021-11-15 11:37
工資低？裸辭？項目黃？走了多少彎路只有我自己知道！

閱讀 3556·2021-09-02 15:21
Zoom 公布其“1 億美元發(fā)展基金”的首輪投資名單

閱讀 2774·2021-09-01 10:31
酷銳云：周年慶第二波，新上香港、美國GIA直連線路特價套餐，限量20臺

閱讀 907·2021-08-31 14:19
HOSTMEM ，$10/年， 1核/512M內(nèi)存/10GB SSD/500GB流量/1G帶寬

閱讀 888·2021-08-11 11:20
傲游主機：美國CN2/香港CN2/德國CN2/荷蘭CN2/香港高防VPS全場8折

閱讀 3343·2021-07-30 15:30
一個圖片偶爾加載不出來的事故

閱讀 1713·2019-08-30 15:54

成人国产在线小视频_日韩寡妇人妻调教在线播放_色成人www永久在线观看_2018国产精品久久_亚洲欧美高清在线30p_亚洲少妇综合一区_黄色在线播放国产_亚洲另类技巧小说校园_国产主播xx日韩_a级毛片在线免费

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！

何成為 QueryPHP 開發(fā)者

相關(guān)文章

QueryPHP V1-beta.3 完成 1.0.0 計劃功能凍結(jié)

QueryPHP V1-beta.1 部分文檔代碼解耦，版本PHP 7.3.2

未來十年的云計算發(fā)展有什么期望？

卷積神經(jīng)網(wǎng)絡(luò)架構(gòu)詳解：它與神經(jīng)網(wǎng)絡(luò)有何不同？

發(fā)表評論

0條評論

bigdevil_s

男|高級講師

TA的文章

1

關(guān)于安裝wireshark中npcap一直無法安裝以及winpcap無法安裝解決方法

工資低？裸辭？項目黃？走了多少彎路只有我自己知道！

Zoom 公布其“1 億美元發(fā)展基金”的首輪投資名單

酷銳云：周年慶第二波，新上香港、美國GIA直連線路特價套餐，限量20臺

HOSTMEM ，$10/年， 1核/512M內(nèi)存/10GB SSD/500GB流量/1G帶寬

傲游主機：美國CN2/香港CN2/德國CN2/荷蘭CN2/香港高防VPS全場8折

一個圖片偶爾加載不出來的事故

最新活動

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！

何成為 QueryPHP 開發(fā)者

相關(guān)文章

發(fā)表評論

0條評論

男|高級講師

TA的文章

最新活動

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！