PHP Laravel数据库字典生成器

前言:

在团队项目开发过程中,数据库设计是非常重要的组成部分,那么数据库设计的变更记录和最新设计的版本通常很难让整个开发团队实时信息同步,于是针对这个问题,我们的解决办法是:
1.在数据库设计的时候在每个字段中都添加备注
2.开发了的数据库字典生成工具,直接生成数据库字典
3.在开发过程中有任何变革,添加好变更SQL记录,并重新生成数据库字典,通知到项目组所有成员(这个步骤尤为重要)

下面就是数据库字典的演示效果

Dictionary

The Dictionary package is meant to provide you, the developer, with a set of tools to help you easily and quickly generate your database dictionay. Of course First make sure you want the database connection to be successful and add a comment for each field of each table.

html format

word format

excel format

Requirements

To install this package you will need:

  • Laravel 5.1+ or Lumen 5.1+
  • PHP 5.5.9+

Installation

You must then modify your composer.json file and run composer update to include the latest version of the package in your project.

"require": {
    "shangjinglong/dictionary": "dev-master"
}

Or you can run the composer require command from your terminal.

composer require shangjinglong/dictionary:dev-master

Laravel

Open config/app.php and register the required service provider above your application providers.

'providers' => [
    Shangjinglong\Dictionary\DictionaryServiceProvider::class
]

Usage

    namespace App\Http\Controllers;
    use Shangjinglong\Dictionary\Dictionary;

    class DictionaryController extends Controller
    {
        public  static function generate(){
            $dictionary = new Dictionary();
            $html = $dictionary->generate();
            return $html;
        }
    }

Support

Please use Github for reporting bugs, and making comments or suggestions.

License

The MIT License (MIT). Please see License File for more information.

发表评论