# 通用版接口

**Repository Path**: aovfx/universal-interface

## Basic Information

- **Project Name**: 通用版接口
- **Description**: 专利系统通用版接口
- **Primary Language**: PHP
- **License**: Not specified
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 4
- **Created**: 2023-04-06
- **Last Updated**: 2023-04-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#项目说明
 本项目基于laravel5.5框架搭建，进行模块化开发，使用repository访问模式进行数据处理。
 
## 环境需求
 * PHP 版本 >= 7.0
 * mysql 版本 >= 5.7
 * Mcrypt PHP 扩展
 * OpenSSL PHP 扩展
 * Mbstring PHP 扩展
 * Tokenizer PHP 扩展
 
## 目录结构
```
 ├─app
 │   ├─Console
 │   ├─Exceptions (错误异常处理目录)
 │   ├─Http
 │   ├─Providers
 ├─bootstrap
 ├─config
 ├─database
 ├─packages (扩展包)
 │   ├─xxx
 │   │   ├─xxx (扩展包源码)
 ├─public
 ├─resources
 ├─routes
 ├─storage
 ├─vendor
 ├─.env
 ├─artisan
 ├─composer.json
 ├─package.json
 ├─server.php
 ├─webpack.mix.js
 ```
 ## 框架扩展包说明
 ### xyt/xxx
 --------------------------
 #### 功能描述
 
 ## 代码规范
 ### 基础编码规范
 
 ### 基本代码规范
 
 本篇规范制定了代码基本元素的相关标准，以确保共享的PHP代码间具有较高程度的技术互通性。
 
 #### 关于「能愿动词」的使用
 
 为了避免歧义，文档大量使用了「能愿动词」，对应的解释如下：
 
 * `必须 (MUST)`：绝对，严格遵循，请照做，无条件遵守；
 * `一定不可 (MUST NOT)`：禁令，严令禁止；
 * `应该 (SHOULD)` ：强烈建议这样做，但是不强求；
 * `不该 (SHOULD NOT)`：强烈不建议这样做，但是不强求；
 * `可以 (MAY)` 和 `可选 (OPTIONAL)` ：选择性高一点，在这个文档内，此词语使用较少；
 
 > 参见：[RFC 2119](http://www.ietf.org/rfc/rfc2119.txt)
 
 ####  1. 概览
 
 - PHP代码文件 **必须** 以 `<?php` 标签开始；
 
 - PHP代码文件 **必须** 以 `不带 BOM 的 UTF-8` 编码；
 
 - PHP代码中 **应该** 只定义类、函数、常量等声明，或其他会产生 `副作用` 的操作（如：生成文件输出以及修改 .ini 配置文件等），二者只能选其一；
 
 - 命名空间以及类 **必须** 符合 PSR 的自动加载规范：[PSR-4]() 中的一个；
 
 - 类的命名 **必须** 遵循 `StudlyCaps` 大写开头的驼峰命名规范；
 
 - 类中的常量所有字母都 **必须** 大写，单词间用下划线分隔；
 
 - 方法名称 **必须** 符合 `camelCase` 式的小写开头驼峰命名规范。
 
 - 代码 **必须** 使用4个空格符而不是「Tab 键」进行缩进。
 
 - 每行的字符数 **应该** 软性保持在 80 个之内，理论上 **一定不可** 多于 120 个，但 **一定不可** 有硬性限制。
 
 - 每个 `namespace` 命名空间声明语句和 `use` 声明语句块后面，**必须** 插入一个空白行。
 
 - 类的开始花括号（`{`） **必须** 写在声明的同行，结束花括号（`}`） **必须** 写在函数主体后自成一行。
 
 - 方法的开始花括号（`{`） **必须** 写在函数声明的同行，结束花括号（`}`） **必须** 写在函数主体后自成一行。
 
 - 类的属性和方法 **必须** 添加访问修饰符（`private`、`protected` 以及 `public`），`abstract` 以及 `final` **必须** 声明在访问修饰符之前，而 `static` **必须** 声明在访问修饰符之后。
   
 - 控制结构的关键字后 **必须** 要有一个空格符，而调用方法或函数时则 **一定不可** 有。
 
 - 控制结构的开始花括号（`{`） **必须** 写在声明的同一行，而结束花括号（`}`） **必须** 写在主体后自成一行。
 

 ####  2. 文件
 
 ##### 2.1. PHP标签
 
 PHP代码 **必须** 使用 `<?php ?>` 长标签；
 
 **一定不可** 使用其它自定义标签。
 
 所有PHP文件 **必须** 使用 `Unix LF (linefeed)` 作为行的结束符。
 
 所有PHP文件 **必须** 以一个空白行作为结束。
 
 纯PHP代码文件 **必须** 省略最后的 `?>` 结束标签。

 
 ##### 2.2. 字符编码
 
 PHP代码 **必须** 且只可使用 `不带BOM的UTF-8` 编码。
 
 
 ####  3. 命名空间和类
 
 命名空间以及类的命名必须遵循 [PSR-4]()。
 
 根据规范，每个类都独立为一个文件，且命名空间至少有一个层次：顶级的组织名称（vendor name）。
 
 类的命名 **必须** 遵循 `StudlyCaps` 大写开头的驼峰命名规范。
 
 PHP 5.3 及以后版本的代码 **必须** 使用正式的命名空间。
 
 
 ####  4. 类的常量、属性和方法
 
 此处的「类」指代所有的类、接口以及可复用代码块（traits）。
 
 ##### 4.1. 常量
 
 类的常量中所有字母都 **必须** 大写，词间以下划线分隔。
 
 参照以下代码：
 
 ```php
<?php
 namespace Vendor\Model;
 
 class Foo
 {
     const VERSION = '1.0';
     const DATE_APPROVED = '2012-06-01';
 }
 ```
 
 ##### 4.2. 属性
 
 每个属性都 **必须** 添加访问修饰符。
 
  **一定不可** 使用关键字 `var` 声明一个属性。
 
 每条语句 **一定不可** 定义超过一个属性。
 
 **不该** 使用下划线作为前缀，来区分属性是 protected 或 private。
 
 类的属性命名 **可以** 遵循：
 
 * 大写开头的驼峰式 (`$StudlyCaps`)
 * 小写开头的驼峰式 (`$camelCase`) 
 * 下划线分隔式 (`$under_score`)
 
 本规范不做强制要求，但无论遵循哪种命名方式，都 **应该** 在一定的范围内保持一致。这个范围可以是整个团队、整个包、整个类或整个方法。
 
 ##### 4.3. 方法
 
 方法名称 **必须** 符合 `camelCase()` 式的小写开头驼峰命名规范。

 所有方法都 **必须** 添加访问修饰符。
 
 **不该** 使用下划线作为前缀，来区分方法是 protected 或 private。
 
 ##### 4.4. 方法的参数
 
 参数列表中，每个逗号后面 **必须** 要有一个空格，而逗号前面 **一定不可** 有空格。
 
 有默认值的参数，**必须** 放到参数列表的末尾。
 
 参数列表 **可以** 分列成多行，这样，包括第一个参数在内的每个参数都 **必须** 单独成行。
 
 拆分成多行的参数列表后，结束括号以及方法开始花括号 **必须** 写在同一行，中间用一个空格分隔。
 
 ##### 4.5. `abstract` 、 `final` 、 以及 `static`
 
 需要添加 `abstract` 或 `final` 声明时，**必须** 写在访问修饰符前，而 `static` 则 **必须** 写在其后。
 
 ##### 4.6. 方法及函数调用
 
 方法及函数调用时，方法名或函数名与参数左括号之间 **一定不可** 有空格，参数右括号前也 **一定不可** 有空格。每个参数前 **一定不可** 有空格，但其后 **必须** 有一个空格。
 
 参数 **可以** 分列成多行，此时包括第一个参数在内的每个参数都 **必须** 单独成行。

### 项目组规范

 #### 1. api规范
 - 普通api地址前缀 **必须** 为 `api/`开头
 
 - 管理功能api地址前缀 **必须** 为 `api/admin/`开头
 
 #### 2. 错误/异常信息处理
 
 - 所有错误信息 **必须** 使用`throw`关键字抛出异常
 
 #### 3. model书写规范
 
 - model对象中所有的通用关联 **必须** 使用`trait`方式提供
 
 - 所有model的trait **必须** 存放在`Models/Traits`下
 
 - 所有的model **必须** 是`BaseModel`子类
 
 - model中的关联处理 **必须** 写全可选参数
 
 - model中 **一定不可** 实现数据的增删改查等处理
 
 #### 4. repository 规范
 
 - 所有的repository **必须** 存放在相应模块下的`Repositories/`目录中
 
 - 所有的repository类名 **必须** 以RepositoryEloquent.php结尾
 
 - 所有的repository类 **必须** 存在对应的接口文件，且 **必须** 存放在对应模块下的`Repositories/Contracts/`目录中
 
 - 所有的repository接口 **必须** 继承`RepositoryInterface`
 
 - 所有的repository接口 **必须** 继承`BaseRepository`,且 **必须** 实现对应的接口
 
 #### 5. route 规范
  
 - 所有的route **必须** 存放在相应模块下的`Routes/`目录中
 
 - 所有接口的路由 **必须** 在`Routes/api.php`文件中
 
 #### 6. 其他规范
 
 - 所有与流程无关的功能 **必须** 以`服务`或`扩展包`的形式提供
 
 - 所有的系统辅助函数 **必须** 存放在`app/helpers.php`中