Skip to content

Latest commit

 

History

History
221 lines (220 loc) · 14.5 KB

README.md

File metadata and controls

221 lines (220 loc) · 14.5 KB
Raw

normphp

normphp致力于在框架层次强制规范开发人员的业务实现来确保实现更高效团队的团队协作与降低后期维护成本。

前言：

  • normphp项目目前为本人一个人维护开发维护
    • 因精力有限README.md形式文档不再继续维护，后期将主要用来简单介绍引导各位了解normphp项目
    • 详细文档与项目生态介绍看访问normphp项目官网
  • 关于官网
    • 官网地址 https://normphp.org
    • 因官网域名未在中国大陆进行ICP备案（org域名貌似无法备案）故官网服务运行在海外服务器上
    • 考虑到必要的安全问题，官网全站使用cloudflare提供的cdn代理服务（在此感谢cloudflare），因此官网在国际网络高峰期时（一般为晚上七点钟开始）访问速度缓慢请各位谅解。
  • 关于项目的未来与初衷
    • 由于设想的normphp项目生态过于庞大，项目之前只是应用在个人项目中使用（代码全在个人gitlab中）于2021-01才慢慢的进行开源
    • normphp项目生态是本人在长期管理开发团队、维护生产环境、设计项目系统架构时碰到的各种问题而针对性规划设计的项目
      • 会基础PHP、LNMP环境知识即可开箱即用运行
      • 开发生态包需要一定的 composer packagist 开发规范知识
        • 控制器、Model（表结构的定义）等都在composer包中开发，在框架初始化时会自动扫描vendor目录下包中的控制器，自动化在app目录创建继承包中控制器的门面控制器对外提供服务。
        • 这样有效的解决了PHP项目模块的快速迭代、多项目的模块复用问题（传统开发模式是在项目中直接编写业务代码、如其他项目或者微服务也需要此业务代码逻辑时就需要人工手动复制备份代码，非常不利于模块化微服务化开发的开发模式）
        • 这样的开发模式非常适合业务模块化、微服务化开发
      • 正如项目名normphp：norm为规范|标准之意，项目生态包在开发时有着较强的规范性（路由的定义、请求参数的数据结构定义、路由返回数据的数据结构定义等）

normphp特性简介：

  • 强大的注解来规范
    • 在由控制器中使用规范的注解来定义路由信息、权限信息等
    • 每个路由的请求数据格式、数据类型、权限配置由注解来定义（不规范的请求数据会被框架的Request类强制过滤并转换成定义的数据类型）。
    • 每个路由的返回数据格式、数据类型由注解来定义（不规范的返回数据会被框架的Request类强制过滤并转换成定义的数据类型）。
    • 每个路由的权限由注解来定义（开实现强大的自定义权限控制，比如可控制到不同的用户访问同一个路由选择性的返回数据）。
    • 自动的根据注解生成API文档、权限文档。
  • 高效的设计模式（DI依赖注入，DIC容器）
    • 详细介绍可谷歌
  • 完美支持SAAS模式
  • 自动化的Db控制
    • 精力有限只做了MySQL5.7的适配
    • 开发者按照规范（表版本、表结构修改、表创建、初始化表数据）构造Model类可实现：
      • 自动管理表版本（在项目开发甚至上线后的维护时都会出现不同程度的表结构修改，每次表结构的修改都设置有一个版本号），db模型可自动判断表是否存在，不存在就根据设置的当前版本号创建表，表存在会判断表版本号是否与当前数据库表版本号一致，不一致根据对应版本自动修改表结构，此方法非常适合SAAS模式下的表结构同步和开发环境与生产环境的同步。同时记录了每次表结构的修改信息也可以通过设置当前版本号来切换到对应的表结构中去。
      • 创建表的步骤是由Db模型负责，可设置Db模型在创建表成功后做初始化数据的插入，插入数据来源目前支持直接在模型里面设置$initData类对应或者通过设置$initDataUrl定义外部请求当前（需要配置加密参数）。
    • 原则上不允许在Model类上写任何业务逻辑，Model类只是用来定义维护数据库表结构，业务逻辑全部在对应包目录下的service目录实现。
  • 新的微服务模式（composer包模式开发运行）
    • 框架的设计初衷是安全精简的微服务框架。
    • 下面介绍一个简单的微服务模式，一个项目可以拆分为下面几个微服务处理。
      • 账号权限微服务（建议使用JWT）。
      • 文件微服务。
      • 异步队列业务处理微服务（可与websocket配合）。
      • websocket服务。
      • 各业务微服务。
  • 完美适配PhpStorm IDE 提供settings.zip配置文件使开发更加规范便捷。

安装方式：

  • 安装方式一直接使用composer创建项目： composer create-project normphp/normphp [项目名称] [版本：dev-main为最新]
 示例：composer create-project normphp/normphp myproject dev-main
  • 安装方式二使用git clone克隆：git clone --branch [tags标签] [email protected]:normphp/normphp.git clone对应分支使用 git clone -b [分支] [email protected]:normphp/normphp.git
 简单示例：
    1、git clone  [email protected]:normphp/normphp.git  #克隆composer.json文件到本地
    2、进入到克隆创建的normphp目录（composer.json同级）
    3、composer install #执行composer命令 或者使用normphp-helper命令行执行
  • 安装方式三（如果你有安装normphp-helper命令行）：normphp -php run 7.4 composer create-project normphp/normphp [项目名称] [版本：dev-main为最新]
 示例：normphp -php run 7.4 composer create-project normphp/normphp myproject  dev-main

快速运行

1、启动命令行窗口（推荐Git Bash Here 或者 PhpStorm Terminal）
2、进入项目目录下的public/目录
3、有两种方式快速启动一个临时性的WEB开发服务，自行选择
# 3-1、直接使用默认PHP版本启动php web服务，运行当前项目
php   -S 127.0.0.1:8080  index.php
# 3-2、使用normphp脚手架（需要先安装）使指定的PHP版本启动php web服务，运行当前项目
normphp -php run 7.4   -S 127.0.0.1:8080  index.php

快速运行

    NGINX伪静态配置：rewrite /$   /项目目录/public/index.php  last;

目录结构

normphp                克隆或者下载解压得到的项目目录
├─app                  项目应用控制器目录
├─config               应用配置目录
│  ├─app               应用配置
│  ├─route             框架自动生成的路由配置文件
│  ├─Deploy.php        项目应用运行部署配置
├─container            门面容器目录（主要是适配IDE）
│  ├─app           
│  │  ├─AppContainer.php           框架门面容器（主要是适配IDE）
│  │  ├─HelperContainer.php        框架Helper函数门面容器（主要是适配IDE）
├─public                           框架入口文件
│  ├─404.php              404错误处理文件（暂时没什么用）
│  ├─index.php            框架入口文件（web项目入口文件）
│  ├─index_cli.php            框架入口文件（CLI入口文件）
├─runtime                     缓存、日志目录
│  ├─errorlog                 错误日志目录
├─vendor                      composer包目录
├─composer.json               命令行下载文件临时保存目录

注意：命令结构可能会更新变化

windows开发环境快速脚手架：

开发规范：

模块包开发规范：

  • normphp框架不建议直接在项目中编写业务代码
    • 如需要开发一个商品管理模块可进行如下步骤：
      • 在您的github.com或者gitlab仓库中创建一个项目：
        • 项目名称为package-goods（项目名称非强制要求，只是建议以这样的格式命名）
        • 在项目中创建如下目录结构
src                克隆或者下载解压得到的项目目录
├─controller                   控制器目录
│  ├─namespaceControllerPath.json                  控制器相关定义文件
├─composer.json                   包定义文件

composer.json文件示例（这里需要一些composer包定义的基础知识）

{
  "name": "normphp-package/goods",
  "description": "normphp",
  "require": {
    "php": ">=7.0.0"
  },
  "repositories": {
  },
  "autoload": {
    "psr-4": {
      "normphpPackage\\demo\\": "src/"
    }
  }
}

namespaceControllerPath.json文件示例（文件主要是用来定义控制器目录、api权限相关配置）

{
  "name":"演示demo",
  "author": "pizepei",
  "explain": "",
  "baseAuthGroup": {
    "systemBasics": {
      "name":"演示demo",
      "explain": "演示demo"
    },
    "systemUser": {
      "name":"系统用户",
      "explain": "演示demo"
    }
  }
}
  • 篇幅有限这里只是简单做介绍
    • 假如您的项目需要一个商品管理模块，我们需要通过composer包的形式进行开发。
    • 控制器文件按照规范编写在包项目的src/controller/下以BasicsXXXX.php显示命名。
    • 当你的项目require了你的商品管理模块包时再次运行项目时就自动的在/app/下创建了控制器文件，此控制器文件继承了您在包中编写的控制器文件
  • 具体的包开发示例前参考
    • github 项目https://github.com/normphp/package-demo
    • 或者直接在项目目录下/vendor/normphp-package/demo/查看相关源代码
    • 相信只要您有一定的composer包开发基础就可以理解如何开发了。
  • 关于如何创建控制器、定义路由等文档后期会持续更新出来
  • 详细具体的开发文档敬请期待normphp.org官网文档

composer 技巧

使用内部源

"config": {
    "process-timeout": 1800,
    "gitlab-oauth": {
        "192.168.1.100": "3Cp6NGxxxxxxxxCw"
    }
}

composer 代理加速

  • 如需要使用官方包管理又苦难速度感人可：
    • 在root composer.json中定当前项目以及依赖的包使用的镜像地址（推荐，默认以配置）：
"repositories": {
    "packagist": {
        "type": "composer",
        "url": "https://mirrors.aliyun.com/composer/"
    }
}
  • 修改源加速 参考https://developer.aliyun.com/composer
    • 如碰到依然无法加速
      • 建议先将Composer版本升级到最新：composer self-update
      • 执行诊断命令：composer diagnose
      • 清除缓存：composer clear
      • 若项目之前已通过其他源安装，则需要更新 composer.lock 文件，执行命令：composer update --lock
    • [命令行]使用代理（不推荐）
    export https_proxy='127.0.0.1:10808'
    export http_proxy='127.0.0.1:10808'
    composer update -vvv    查看是否使用代理

更新命名空间

  composer dumpautoload

单元测试：

composer require --dev phpunit/phpunit:8

###资源分享

软件

PHP扩展安装

  • PHP 扩展下载 http://pecl.php.net/
  • PHP 常用扩展 https://pecl.php.net/package-stats.php https://www.php.net/manual/zh/refs.basic.other.php
  • sql server 拓展安装（注意细节）
    • 准备工作:
      • 下载地址：http://pecl.php.net/package/pdo_sqlsrv
      • 加入微软的源 curl https://packages.microsoft.com/config/rhel/7/prod.repo > /etc/yum.repos.d/mssqlrelease.repo
      • 或者一次性 安装所有依赖包
        • 防止冲突先卸载原有版本(可选) yum remove unixODBC
        • yum -y install gcc gcc-c++ autoconf libjpeg libjpeg-devel libpng libpng-devel freetype freetype-devel libxml2 libxml2-devel zlib zlib-devel glibc glibc-devel glib2 glib2-devel bzip2 bzip2-devel ncurses ncurses-devel curl curl-devel e2fsprogs e2fsprogs-devel krb5-devel libidn libidn-devel openssl openssl-devel nss_ldap openldap openldap-devel openldap-clients openldap-servers libxslt-devel libevent-devel ntp libtool-ltdl bison libtool vim-enhanced msodbcsql mssql-tools unixODBC-devel
    • 编译安装pdo_sqlsrv驱动
      • 避免出现make: *** No rule to make target `install'. Stop.错误（因为缺少依赖包的原因，请执行上面的依赖安装命令）
      • 为了避免make 时出现【fatal error: sql.h: No such file or directory】错误 （ 安装unixodbc的工具包即可 yum install unixODBC-devel ）
      • 与mysql不同 的dbh new PDO("sqlsrv:Server=localhost,端口号;Database=数据库", 用户名 , 密码);

composer

活久见