# yii2-base

**Repository Path**: zhou3/yii2-base

## Basic Information

- **Project Name**: yii2-base
- **Description**: No description available
- **Primary Language**: PHP
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-16
- **Last Updated**: 2025-05-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 贷超系统

环境
-------------------
1.统一使用PHPSTORM作为编辑器
2.使用PHP8.1作为开发，生产环境, 扩展 php-mongodb, php-redis,php-mbstring, php-openssl, php-gd2, php-curl php-bcmath
3.安装： 集成环境phpstudy 或单独安装 mysql, nginx
4.建议安装：navicat 12 , notepad或其他文本编辑器， xshell
5.composer 中国镜像：https://pkg.phpcomposer.com/
6.nginx配置文件可以复制vagrant/nginx/vhosts.conf , 需要修改项目的根目录，修改域名，和在hosts中把域名指向127.0.0.1

编码规范
-------------------
https://github.com/yiisoft/yii2/blob/master/docs/internals/core-code-style.md

在PHPSTORM中安装：
1、Settings → Languages & Frameworks → PHP → Code Sniffer →
Configuration:Local→ 'PHP Code Sniffer(phpcs) path'选择你的phpcs的路径（vendor\squizlabs\php_codesniffer\bin\phpcs.bat） →
Validate → OK
2、Settings → Editor → Inspections → PHP → Unused:PHP Code Sniffer validation 勾选上 → Coding standard 选择Yii2 → OK

数据库规范
-------------------
1.字段统一使用小写， 下划线分割，单数
2.表名和字段名尽量加上注释，除去类似 id, created_at, updated_at 等一看就明白的字段
3.对于常用的查询字段加上索引
4.内部用户ID 使用 user_id, 外部的用户ID/订单id加上外部修饰词作为区分，比如机构用户ID org_user_id


项目目录
-------------------

```
common                   通用类目录
    api                  调用外部API接口目录
    config/              contains shared configurations
    enums/               枚举目录
        codes            返回码目录
            CommonCode   和业务无关的普通返回码 命名范围 10000 - 11000 以及-1
            ThirdpartyCode  第三方返回码 命名范围 20000 - 30000
    helpers/             帮助类
    services/            服务类
        risk/            风控相关
        thirdparty/      第三方
        user/            用户相关
    mail/                contains view files for e-mails
    models/              contains model classes used in both backend and frontend
    tests/               contains tests for common classes    
    
console                  脚本启动目录
    config/              contains console configurations
    controllers/         contains console controllers (commands)
    migrations/          contains database migrations
    models/              contains console-specific model classes
    runtime/             contains files generated during runtime
    
backend                  后台管理
    assets/              contains application assets such as JavaScript and CSS
    config/              contains backend configurations
    controllers/         contains Web controller classes
    models/              contains backend-specific model classes
    runtime/             contains files generated during runtime
    tests/               contains tests for backend application    
    views/               contains view files for the Web application
    web/                 contains the entry script and Web resources
    
frontend                 api接口
    assets/              contains application assets such as JavaScript and CSS
    config/              contains frontend configurations
    controllers/         contains Web controller classes
    models/              contains frontend-specific model classes
    runtime/             contains files generated during runtime
    tests/               contains tests for frontend application
    views/               contains view files for the Web application
    web/                 contains the entry script and Web resources
    widgets/             contains frontend widgets
    
vendor/                  contains dependent 3rd-party packages

environments/            contains environment-based overrides
```

架构说明
-------------------
框架使用 MVC + Services 。 Service是主要的处理逻辑层，作为提供给 backend, frontend, console 里的controller共同使用。
redis作为缓存，不存储持久数据

涉及到环境的配置放在 environments对应的环境下
通用的配置放在common下
和入口项目相关的配置放在 项目目录下

本地开发
-------------------

```shell
## 还原到最初状态（一般不执行）
git clean -dfn
git clean -dfx 

## 初始化环境
./init --env=Development
## ./init.bat --env=Development (For Windows)

## cp ./tests/phpunit.xml.dist ./tests/phpunit.xml

# 本地配置文件
export YII_CONFIG_YML="./environments/yaml/local.yml" && ./fetch-config
```