# eggjs
//脚手架工具
cnpm i egg-init -g
简化操作,路由约定自动加载,约定优于定义
console.log(require(egg.js))
{ startCluster: [Function],
start: [AsyncFunction],
Application: [Function: Application],
Agent: [Function: Agent],
AppWorkerLoader: [Function: AppWorkerLoader],
AgentWorkerLoader: [Function: AgentWorkerLoader],
Controller: [Function: BaseContextClass],
Service: [Function: BaseContextClass],
Subscription: [Function: BaseContextClass],
BaseContextClass: [Function: BaseContextClass],
Boot: [Function: BaseHookClass] }
目录结构
- app
- controller
- model
- service
- router.js
- config
- config.default.js
- plugin.js
- test
- logs
- ....
controller
'use strict';
const Controller = require('egg').Controller;
class UserController extends Controller {
async index() {
const { ctx } = this;
// ctx.body = 'go';
ctx.body= await ctx.service.user.getall()
}
}
module.exports = UserController;
service
'use strict';
const Service = require('egg').Service;
class UserService extends Service {
async getall() {
return await this.ctx.model.User.findAll()
// return [
// {name:"zhangsan"},
// {name:"lisi"}
// ]
}
}
module.exports = UserService;
model
module.exports = app => {
const { STRING } = app.Sequelize;
const User = app.model.define(
"user",
{ name: STRING(30) },
{ timestamps: false }
);
// 数据库同步
// User.sync({force: true})
return User;
};
router.js
'use strict';
/**
* @param {Egg.Application} app - egg application
*/
module.exports = app => {
const { router, controller } = app;
router.get('/', controller.home.index);
router.get('/user', controller.user.index);
};
model service controller层的文件名字不能乱改,因为是约定的,不需要额外配置,只有router.js里要手动添加一下接口路由,而且也不需要引入的
config.default.js
/* eslint valid-jsdoc: "off" */
'use strict';
/**
* @param {Egg.EggAppInfo} appInfo app info
*/
module.exports = appInfo => {
/**
* built-in config
* @type {Egg.EggAppConfig}
**/
const config = exports = {};
// use for cookie sign key, should change to your own and keep security
config.keys = appInfo.name + '_1586241771946_3772';
// add your middleware config here
config.middleware = [];
// add your user config here
const userConfig = {
// myAppName: 'egg',
sequelize: {
dialect: "mysql",
host: "127.0.0.1",
port: 3306,
username: "root",
password: "",
database: "kaikeba"
}
};
return {
...config,
...userConfig,
};
};
plugin.js
'use strict';
/** @type Egg.EggPlugin */
module.exports = {
// had enabled by egg
// static: {
// enable: true,
// }
sequelize: {
enable: true,
package: 'egg-sequelize',
}
};