jj.js 0.18.0 → 0.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,140 +1,208 @@
1
1
  # jj.js
2
2
 
3
- ![jj.js](https://me.i-i.me/static/images/jjjs.png "jj.js")
3
+ ![jj.js](./logo.png "jj.js")
4
4
 
5
- A super simple lightweight NodeJS MVC framework(一个超级简单轻量的NodeJS MVC框架)
5
+ > 一个超级简单轻量的 Node.js MVC 框架
6
6
 
7
- ## 项目介绍
7
+ ## 📖 项目介绍
8
8
 
9
- 无论什么语言什么框架的程序,类库的使用都离不开requireimport、include等导入模块,不用时,还得删除。而本框架基于proxy实现了类库自动加载、懒加载和Class自动实例化及单例化技术,所有的类库,想用直接调用,系统会自动导入。
9
+ jj.js 是一个模仿 ThinkPHP5 设计的轻量级 Node.js MVC 框架。基于 Proxy 实现了**类库自动加载**、**懒加载**和 **Class 自动实例化及单例化**技术,所有类库想用直接调用,系统会自动导入,无需手动 require/import
10
10
 
11
- ### 项目特性
11
+ ### ✨ 核心特性
12
12
 
13
- 1. 系统架构为经典的MVC模式,模仿Thinkphp5,很容易上手
14
- 2. 系统类库、用户类库都支持自动加载、懒加载、Class自动生成单实例
15
- 3. 支持应用级、路由级、控制器级三级中间件,方便插件及二次开发
16
- 4. 支持单应用和多应用两种运行模式
17
- 5. 基于jsdoc,提供完整的代码提示,自动生成应用端types类型文件
13
+ | 特性 | 说明 |
14
+ |------|------|
15
+ | 🏗️ **经典 MVC** | 模仿 ThinkPHP5,PHP 开发者友好,快速上手 |
16
+ | 🔄 **自动加载** | 系统类库、用户类库都支持自动加载、懒加载 |
17
+ | 🎯 **智能实例化** | Class 自动生成单实例,节省内存开销 |
18
+ | 🧩 **三级中间件** | 应用级、路由级、控制器级,方便插件及二次开发 |
19
+ | 🌐 **多应用模式** | 支持单应用和多应用两种运行模式 |
20
+ | 📝 **完整类型提示** | 基于 JSDoc,自动生成应用端 types 类型文件 |
18
21
 
19
- ### 项目地址
22
+ ### 📍 项目地址
20
23
 
21
- 项目地址:[https://github.com/yafoo/jj.js](https://github.com/yafoo/jj.js "https://github.com/yafoo/jj.js")
24
+ - **GitHub**:[https://github.com/yafoo/jj.js](https://github.com/yafoo/jj.js)
25
+ - **码云镜像**:[https://gitee.com/yafu/jj.js](https://gitee.com/yafu/jj.js)
26
+ - **官网**:[https://me.i-i.me/special/jj.html](https://me.i-i.me/special/jj.html)
22
27
 
23
- 码云镜像:[https://gitee.com/yafu/jj.js](https://gitee.com/yafu/jj.js "https://gitee.com/yafu/jj.js")
28
+ ---
24
29
 
25
- 官网地址:[https://me.i-i.me/special/jj.html](https://me.i-i.me/special/jj.html "https://me.i-i.me/special/jj.html")
26
-
30
+ ## 🚀 快速开始
27
31
 
28
- ## 安装
32
+ ### 安装
29
33
 
30
34
  ```bash
31
35
  npm i jj.js
32
36
  ```
33
37
 
34
- > 运行环境要求:node.js >= v12.7.0
38
+ > **运行环境要求**:Node.js >= 18
35
39
 
36
- ## Hello world !
40
+ ### Hello World
37
41
 
38
- 1、创建控制器文件 `./app/controller/index.js`
42
+ **1. 创建控制器** `./app/controller/index.js`
39
43
 
40
44
  ```javascript
41
45
  const {Controller} = require('jj.js');
42
46
 
43
- class Index extends Controller
44
- {
47
+ class Index extends Controller {
45
48
  async index() {
46
- this.$show('Hello jj.js, hello world !');
49
+ this.$show('Hello jj.js, hello world!');
47
50
  }
48
51
  }
49
52
 
50
53
  module.exports = Index;
51
54
  ```
52
55
 
53
- 2、创建应用入口文件 `./server.js`
56
+ **2. 创建应用入口** `./server.js`
54
57
 
55
58
  ```javascript
56
59
  const {App, Logger} = require('jj.js');
57
60
  const app = new App();
58
61
 
59
- app.run(3000, '0.0.0.0', function(err){
60
- !err && Logger.log('app', 'http server is ready on 3000');
62
+ app.listen(3000, '0.0.0.0', () => {
63
+ Logger.info('HTTP server is ready on port 3000');
61
64
  });
62
65
  ```
63
66
 
64
- 3、运行命令
67
+ **3. 启动服务**
65
68
 
66
69
  ```bash
67
70
  node server.js
68
71
  ```
69
72
 
70
- 4、浏览器访问 `http://127.0.0.1:3000`,页面输出 `Hello jj.js, hello world !`
73
+ **4. 访问测试**
71
74
 
72
- 5、在Stackblitz中打开 [Hello world !](https://stackblitz.com/edit/node-frhrfi?embed=1&file=app/controller/index.js)
75
+ 浏览器打开 `http://127.0.0.1:3000`,页面输出:`Hello jj.js, hello world!`
73
76
 
74
- ## 开发手册
77
+ > 💡 在线体验:[Stackblitz Hello World](https://stackblitz.com/edit/node-frhrfi?embed=1&file=app/controller/index.js)
78
+
79
+ ---
80
+
81
+ ## 📚 开发手册
75
82
 
76
83
  ### 应用目录结构
77
84
 
78
85
  ```
79
- ├── app //应用目录 (非必需,可改名)
80
- ├── controller //控制器目录 (非必需,可改名)
81
- │ └── index.js //控制器
82
- ├── view //模板目录 (非必需,可改名)
83
- │ └── index //index控制器模板目录 (非必需,可改名)
84
- └── index.htm //模板
85
- ├── middleware //中间件目录 (非必需,不可改名)
86
- ├── model //模型目录 (非必需,可改名)
87
- ├── pagination //分页目录 (非必需,可改名)
88
- ├── logic //逻辑目录 (非必需,可改名)
89
- └── **** //其他目录 (非必需,可改名)
90
- ├── app2 //应用2目录 (非必需,可改名)
91
- ├── common //公共应用目录 (非必需,可改名)
92
- ├── config //配置目录 (非必需,不可改名)
93
- ├── app.js //APP配置 (非必需,不可改名)
94
- ├── db.js //数据库配置 (非必需,不可改名)
95
- ├── routes.js //路由配置 (非必需,不可改名)
96
- ├── view.js //模版配置 (非必需,不可改名)
97
- ├── cache.js //缓存配置 (非必需,不可改名)
98
- └── **** //其他配置 (非必需,可改名)
99
- ├── public //静态访问目录 (非必需,可改名)
100
- └── static //css image文件目录 (非必需,可改名)
101
- ├── node_modules //nodejs模块目录
102
- ├── server.js //应用入口文件 (必需,可改名)
103
- └── package.json //npm package.json
86
+ project/
87
+ ├── app/ # 应用目录(默认应用,可改名)
88
+ ├── controller/ # 控制器目录(可改名)
89
+ │ └── index.js # 首页控制器
90
+ ├── view/ # 模板目录(可改名)
91
+ └── index/ # index 控制器模板
92
+ │ └── index.htm # 模板文件
93
+ ├── middleware/ # 中间件目录(不可改名)
94
+ ├── model/ # 模型目录(可改名)
95
+ ├── pagination/ # 分页目录(可改名)
96
+ ├── logic/ # 逻辑目录(可改名)
97
+ │ └── ... # 其他自定义目录
98
+ ├── common/ # 公共应用目录(可选)
99
+ ├── config/ # 配置目录(不可改名)
100
+ ├── app.js # 应用配置
101
+ ├── db.js # 数据库配置
102
+ ├── routes.js # 路由配置
103
+ ├── view.js # 模板配置
104
+ ├── cache.js # 缓存配置
105
+ └── ... # 其他配置
106
+ ├── public/ # 静态资源目录(可改名)
107
+ └── static/ # CSS/JS/图片等
108
+ ├── node_modules/ # Node.js 依赖
109
+ ├── server.js # 应用入口文件(必需,可改名)
110
+ ├── types.js # JSDOC类型文件(开发模式自动生成)
111
+ ├── jsconfig.json # 代码提示配置(没有,则编辑器不会提示)
112
+ └── package.json # NPM 配置
104
113
  ```
105
- #### 应用目录介绍:
106
- - **config**: 应用配置目录,系统的所有配置参数都放这里,也可以简化为一个config
107
- .js文件,所有配置参数会覆盖框架默认参数。其中config这个名字不允许修改。
108
- - **app、app2、common**: 为应用目录,common为公共应用目录,可以存放公共的model、logic或其他的文件,app为默认访问的应用。jj.js框架支持单应用和多应用运行模式,在`./config/app.js`中把`app_multi`设置为`true`即为多应用模式,此时可以创建app2、app3更多应用。框架默认为单应用模式。
109
- - **public**:静态资源目录,主要存放css文件、js文件、图片等静态资源。在`./config/app.js`中通过`static_dir`参数可以设置或更改静态目录名字,为空时,则关闭静态访问(系统不会加载静态资源访问的逻辑,最大节省内容,也即所谓的轻量)
110
- - **server.js**:应用入口文件,名字可以任意改。
111
114
 
112
- ### 系统类库
115
+ #### 📁 目录说明
116
+
117
+ | 目录 | 必需 | 说明 |
118
+ |------|------|------|
119
+ | `config/` | ❌ | 应用配置目录,所有配置参数放在这里,可简化为 `config.js` |
120
+ | `app/` | ✅ | 默认应用目录,支持多应用时可创建 `app2`、`app3` 等 |
121
+ | `common/` | ❌ | 公共应用目录,存放公共 model、logic 等 |
122
+ | `public/` | ❌ | 静态资源目录,在 `config/app.js` 中通过 `static_dir` 配置 |
123
+ | `server.js` | ✅ | 应用入口文件,名字可任意修改 |
124
+
125
+ > **多应用模式**:在 `./config/app.js` 中设置 `app_multi: true` 即可启用。
126
+
127
+ ---
128
+
129
+ ### 🏛️ 系统类库
113
130
 
114
131
  ```javascript
115
- const {App, Controller, Db, Model, Pagination, View, Logger, Cookie, Response, Upload, Url, Middleware, Cache, Context, View} = require('jj.js');
132
+ const {
133
+ App, // 应用类(继承 Koa)
134
+ Controller, // 控制器基类
135
+ Db, // 数据库类
136
+ Model, // 模型基类
137
+ Pagination, // 分页类
138
+ View, // 视图/模板类
139
+ Logger, // 日志类(静态类)
140
+ Cookie, // Cookie 操作类
141
+ Response, // 响应类
142
+ Upload, // 文件上传类
143
+ Url, // URL 生成类
144
+ Middleware, // 中间件基类
145
+ Cache, // 缓存类(静态类)
146
+ Context, // 上下文基类
147
+ Request // 请求类
148
+ } = require('jj.js');
116
149
  ```
117
150
 
118
- ![jj.js类库继承关系图](https://me.i-i.me/static/images/jj_class.png "jj.js类库继承关系图")
151
+ #### 🌳 类库继承关系图
152
+
153
+ ```
154
+ Ctx (Proxy 基类 - 核心自动加载机制)
155
+
156
+ └── Context (基础上下文类)
157
+
158
+ ├── Middleware (中间件基类)
159
+ │ │
160
+ │ └── Controller (控制器类)
161
+ │ └── 用户自定义控制器
162
+
163
+ ├── Model (模型类)
164
+ │ └── 用户自定义模型
165
+
166
+ ├── Db (数据库类)
167
+ │ ├── Mysql (lib/db/mysql.js)
168
+ │ ├── Sqlite (lib/db/sqlite.js)
169
+ │ └── Mongodb (lib/db/mongodb.js)
170
+
171
+ ├── View (视图/模板类)
172
+ ├── Response (响应类)
173
+ ├── Request (请求类)
174
+ ├── Url (URL 生成类)
175
+ ├── Cookie (Cookie 操作类)
176
+ ├── Upload (文件上传类)
177
+ └── Pagination (分页类)
178
+
179
+ 静态类(不需要继承):
180
+ ├── Logger (日志类)
181
+ └── Cache (缓存类)
182
+ ```
183
+
184
+ > 💡 **开发建议**:继承系统类库后,可在类内使用 `$` 前缀属性实现自动加载功能。链式调用类方法时会自动实例化单例。
185
+
186
+ ---
119
187
 
120
- 系统类库都是`Class`类型,其中`Logger`和`Cache`是静态类;开发时建议继承系统类库,这样可以在类内使用`$`开头的属性,实现自动加载功能,链式调用类方法时会自动实例化一个单例。例如,在控制器内使用 `this.$logger` 会返回系统Logger类,使用 `this.$logger.info()`,会自动生成一个`logger`单例,并调用`info`方法,其他系统类库及类库内可以以这种方法调用。
188
+ ### 🔄 类库自动加载
121
189
 
122
- ### 类库自动加载
190
+ > 类库自动加载、懒加载是整个框架的核心。
123
191
 
124
- > 类库自动加载、懒加载是整个框架的核心,这里以hello world!示例程序先简单做个介绍。
192
+ #### 示例 1:直接使用系统类库
125
193
 
126
- 1、假如想在`./app/controller/index.js`控制器的`user`方法中读取`user`数据表中`id`为1的用户,我们直接上代码:
194
+ **控制器** `./app/controller/index.js`:
127
195
 
128
196
  ```javascript
129
197
  const {Controller} = require('jj.js');
130
198
 
131
- class Index extends Controller
132
- {
199
+ class Index extends Controller {
133
200
  async index() {
134
- this.$show('Hello jj.js, hello world !');
201
+ this.$show('Hello jj.js, hello world!');
135
202
  }
136
203
 
137
204
  async user() {
205
+ // 直接使用 $db,框架自动加载并实例化
138
206
  const user_info = await this.$db.table('user').find({id: 1});
139
207
  this.$show(user_info);
140
208
  }
@@ -143,156 +211,156 @@ class Index extends Controller
143
211
  module.exports = Index;
144
212
  ```
145
213
 
146
- - 访问url:`http://127.0.0.1:3000/index/user`,即可看到打印的json用户信息。
214
+ **访问**:`http://127.0.0.1:3000/index/user`
147
215
 
148
- - 其中`async user() {}`为异步方法,在控制器中,对外可以以url访问的方法必须设置为异步函数。使用`this.$db`调用框架db类,这里控制器必须继承框架`Controller`类,否则会调用失败。
216
+ **加载流程**:
149
217
 
150
- - 在控制器中,前缀为`$`字符的属性为特殊属性,框架首先会检测本类中即`this`实例中是否有`$db`属性,有的话,会直接调用。如果没有,会检测本类文件所在应用目录即`./app/`目录下,是否用`db`目录或文件,如果有,则`$db`即代表那个目录或文件,`this.$db.table`会继续在db目录下寻找table目录或文件。如果`db`目录或文件不存在,框架会在应用根目录`./`下找,是否有`db`目录或文件,如果有,和上面一样。如果还不存在,框架会在jj.js框架`lib`目录下找`db`文件或目录,而框架`lib`中有`db.js`文件,至此,`this.$db`成功访问到框架`db`类。
151
-
152
- - 如果将`this.$db`赋值为给一个变量,`const db = this.$db;`,得到的将是一个`db` Class类,可以进行new操作,`const db = this.$db; const db1 = new db(this.ctx, options); const db2 = new this.$db(this.ctx, options);`创建多个实例。
153
-
154
- - 但上面演示代码并没有new一个实例,而是直接调用`db`类的`table()`方法,这正是框架的智能之处。当调用`this.$db.table('user')`时,框架首先会检测db类是否有`table`静态属性,有的话会直接调用。没有,则会自动new一个`db`实例,而且这个实例是个单例,然后调用此`db`实例的`table`方法,`table('user')`设置数据表名后返回实例本身,然后紧接着调用`find()`方法,读取用户ID为1的数据。
155
-
156
- > 注意:虽然系统加载很复杂, 但是基于node的常驻内存特性,上面的文件路径判断,处理一次就会被缓存下来,在下个生命周期不用重复判断,节省性能。
218
+ ```
219
+ this.$db
220
+
221
+ 1. 检查当前类实例是否有 $db 属性
222
+ (没有)
223
+ 2. 检查应用目录 ./app/db.js 或 ./app/db/
224
+ (没有)
225
+ 3. 检查应用根目录 ./db.js 或 ./db/
226
+ ↓ (没有)
227
+ 4. 检查框架 lib/db.js ✅ 找到!
228
+
229
+ 自动实例化(单例)并返回 Db 实例
230
+ ```
157
231
 
158
- > 关于单例:通过`this.$xxx`调用的类实例,在单个生命周期内是单例,即不管调用几次,都是用的同一个实例,这样非常节省内存开销。如果有多个db实例需求,可以用上面的方法,自己`new`创建,自己创建时注意第一个参数需传入ctx,否则部分类库使用会出现异常。
232
+ > **智能实例化**:调用 `this.$db.table('user')` 时,框架先检测是否有 `table` 静态方法,没有则自动 new 实例,然后调用实例方法。
159
233
 
160
- > 生命周期:应用生命周期以url访问为单位,一次url访问到访问结束,是一个独立的生命周期,在这个周期内自动生成的单实例都是共用的。
234
+ #### 示例 2:使用自定义模型
161
235
 
162
- 2、假如自己创建了数据表模型`./app/model/user.js`,然后想在控制器中使用,模型文件代码如下:
236
+ **模型** `./app/model/user.js`:
163
237
 
164
238
  ```javascript
165
239
  const {Model} = require('jj.js');
166
240
 
167
- class User extends Model
168
- {
241
+ class User extends Model {
169
242
  async getUserInfo(condition) {
170
- const user_info = await this.db.find(condition);
171
- return user_info;
243
+ return await this.db.find(condition);
172
244
  }
173
245
  }
174
246
 
175
247
  module.exports = User;
176
248
  ```
177
249
 
178
- 这时在控制器的user方法中读取user数据表中id为1的用户,我们直接上代码:
250
+ **控制器调用**:
179
251
 
180
252
  ```javascript
181
- const {Controller} = require('jj.js');
182
-
183
- class Index extends Controller
184
- {
185
- async index() {
186
- this.$show('Hello jj.js, hello world !');
187
- }
188
-
189
- async user() {
190
- const user_info = await this.$model.user.getUserInfo({id: 1});
191
- this.$show(user_info);
192
- }
253
+ async user() {
254
+ // 自动加载 ./app/model/user.js 并调用 getUserInfo 方法
255
+ const user_info = await this.$model.user.getUserInfo({id: 1});
256
+ this.$show(user_info);
193
257
  }
194
-
195
- module.exports = Index;
196
258
  ```
197
259
 
198
- - 访问url:`http://127.0.0.1:3000/index/user`,同样看到打印的json用户信息。
199
-
200
- - 根据示例1的加载检测机制,`this.$model`会自动定位到`./app/model/`目录,`this.$model.user`会自动加载`./app/model/user.js`类文件,调用方法`getUserInfo`,会自动生成一个`user`模型的单实例,并调此单实例的`getUserInfo`方法。
201
-
202
- - 可以看到,不管是系统类库,还是自定义类库,都可以实现自动加载、懒加载、自动生成单实例。
260
+ > **注意**:模型内使用 `this.db`(无 `$` 前缀)是专属该模型的独立实例,避免多模型调用时混淆。
203
261
 
204
- > 注意:在`user`模型内调用的是`this.db`,`db`没有`$`前缀,这个`db`是专属于`user`模型的独立实例,与示例1生成的`db`实例不是同一个。当然也可以使用带`$`前缀的`db`,但这样,在一个生命周期同时调用多个不同的模型的话,容易造成混淆。
262
+ ---
205
263
 
206
- 3、除了框架db类、自定义模型类,整个应用和框架的所有自定义类库、配置文件,都支持同过`this.$xxxx`调用。
264
+ ### ⚙️ Config 配置
207
265
 
208
- ### config配置
266
+ 应用配置可以是 `./config/` 目录,也可以简化为一个 `./config.js` 文件。只需设置需要修改的项,未设置的会继承框架默认配置。
209
267
 
210
- 应用的配置可以为`./config/`目录+`./config/xxx.js`文件的形式,也可以直接写到一个`./config.js`文件里。
268
+ #### App 配置 `./config/app.js`
211
269
 
212
- 应用配置不用每项都设置,只设置自己需要改的,默认会继承框架的默认配置,在控制器、中间件、模板类、模型类里都可以通过`this.$config.xxx`使用。
213
-
214
- - app配置`./config/app.js`:
215
270
  ```javascript
216
- const app = {
217
- app_debug: true, // 调试模式
218
- app_multi: false, // 是否开启多应用
219
-
220
- default_app: 'app', // 默认应用
221
- default_controller: 'index', //默认控制器
222
- default_action: 'index', // 默认方法
223
-
224
- common_app: 'common', // 公共应用,存放公共模型及逻辑
225
- controller_folder: 'controller', //控制器目录名
271
+ module.exports = {
272
+ app_debug: false, // 调试模式
273
+ app_multi: false, // 是否开启多应用
274
+ default_app: 'app', // 默认应用
275
+ default_controller: 'index', // 默认控制器
276
+ default_action: 'index', // 默认方法
277
+ common_app: 'common', // 公共应用
278
+ controller_folder: 'controller', // 控制器目录名
279
+ static_dir: '', // 静态文件目录(为空关闭静态访问)
280
+ koa_body: null // koa-body 配置(null 关闭)
281
+ };
282
+ ```
226
283
 
227
- static_dir: '', // 静态文件目录,相对于应用根目录,为空或false时,关闭静态访问
284
+ #### 数据库配置 `./config/db.js`
228
285
 
229
- koa_body: null // koa-body配置参数,为''、null、false时,关闭koa-body,此时upload类将不可用,并且系统接收不到post参数。启用的话,建议配置:{multipart: true, formidable: {keepExtensions: true, maxFieldsSize: 10 * 1024 * 1024}}
230
- }
231
- module.exports = app;
232
- ```
233
- - 数据库配置`./config/db.js`:可以配置多个,方便程序里切换使用。
234
286
  ```javascript
235
- const db = {
287
+ module.exports = {
236
288
  default: {
237
- type : 'mysql', // 数据库类型
238
- host : '127.0.0.1', // 服务器地址
239
- database : 'jj', // 数据库名
240
- user : 'root', // 数据库用户名
241
- password : '', // 数据库密码
242
- port : '', // 数据库连接端口
243
- charset : 'utf8', // 数据库编码默认采用utf8
244
- prefix : 'jj_' // 数据库表前缀
289
+ type: 'mysql',
290
+ host: '127.0.0.1',
291
+ database: 'jj',
292
+ user: 'root',
293
+ password: '',
294
+ port: '',
295
+ charset: 'utf8mb4',
296
+ prefix: 'jj_'
297
+ },
298
+ sqlite: {
299
+ type: 'sqlite',
300
+ database: ':memory:',
301
+ prefix: 'jj_'
302
+ },
303
+ mongodb: {
304
+ type: 'mongodb',
305
+ host: '127.0.0.1',
306
+ database: 'jj',
307
+ port: 27017,
308
+ prefix: 'jj_'
245
309
  }
246
- }
247
- module.exports = db;
310
+ };
248
311
  ```
249
312
 
250
- - 路由配置`./config/routes.js`:
251
- 路由功能基于`@koa/router`开发,关于url匹配规则可以参考官方文档:[文档地址](https://www.npmjs.com/package/@koa/router)
313
+ #### 路由配置 `./config/routes.js`
252
314
 
253
- > 本框架默认内置 `应用/控制器/方法` 的全局路由,即如果不需要定制url,可以直接访问,无需配置路由。
315
+ 基于 `@koa/router` 开发,支持 URL 匹配、路由命名、反向编译等功能。
254
316
 
255
- > 路由配置为一个数组,每一项为一条规则,项属性包含url规则,path访问路径,name规则名字,type路由类型。url一旦匹配,即会停止,如果需要继续向下匹配,需在程序内调用 `await this.$next();`,路由配置参考示例:
256
317
  ```javascript
257
- routes = [
258
- {url: '/', path: 'app/index/index2'}, // 访问'/',会定位到app应用的index控制的index2方法
259
- {url: '/article/:id.html', path: 'app/article/article', name: 'article'}, // 访问'/article/123.html',会定位到app应用的article控制的article方法;通过this.ctx.params.id可以获取到参数id;通过article可以反编译网址,执行this.$url.build(':article', {id: 123}); 生成'/article/123.html'
260
- {url: '/admin', path: 'app/admin/check', type: 'middleware'}, // 访问'/admin',会定位到app应用的admin中间件的check方法
261
- {url: '/about', path: 'app/about/index', type: 'view'}, // 访问'/about',会定位到app应用的view模板目录about目录下的index.htm文件,并直接输出文件内容
262
- {url: '/:cate/list_:page.html', path: 'cate/cate', name: 'cate_page'}, // 多参数分页示例
263
- {url: '/hello', path: async (ctx, next) => {ctx.body = 'hello world, hello jj.js!';}} // 直接路由到函数
318
+ module.exports = [
319
+ // 基本路由
320
+ {url: '/', path: 'app/index/index2'},
321
+
322
+ // 动态参数 + 路由命名
323
+ {url: '/article/:id.html', path: 'app/article/article', name: 'article'},
324
+
325
+ // 中间件类型
326
+ {url: '/admin', path: 'app/admin/check', type: 'middleware'},
327
+
328
+ // 模板直接输出
329
+ {url: '/about', path: 'app/about/index', type: 'view'},
330
+
331
+ // 直接路由到函数
332
+ {url: '/hello', path: async (ctx, next) => {
333
+ ctx.body = 'hello world!';
334
+ }}
264
335
  ];
265
-
266
- module.exports = routes;
267
336
  ```
268
- > 注意:本路由配置示例前两条规则为常规用法,后面的非常规用法,不建议使用。如果是单应用模式,可以去掉path参数里的app。
269
337
 
270
- - 自定义配置`./config/self.js`:自定义配置同样可以直接通过`this.$config.self`使用。
271
- ```javascript
272
- const self = {
273
- option1: ''
274
- option2: ''
275
- ...
276
- }
277
- module.exports = self;
278
- ```
279
- - 其他配置项,请参考系统配置文件`jj.js/lib/config.js`
338
+ > **反向编译**:配置 `name` 后,可使用 `this.$url.build(':article', {id: 123})` 生成 `/article/123.html`
280
339
 
281
- ### 编码命名规范
340
+ ---
282
341
 
283
- 类名使用大驼峰,方法名使用小驼峰,私有方法使用下划线前缀。
284
- 控制器文件名使用小写下划线。
342
+ ### 📝 编码命名规范
285
343
 
344
+ | 类型 | 规范 | 示例 |
345
+ |------|------|------|
346
+ | 类名 | 大驼峰 | `UserController` |
347
+ | 方法名 | 小驼峰 | `getUserInfo()` |
348
+ | 私有方法 | 下划线前缀 | `_validateData()` |
349
+ | 控制器文件名 | 小写下划线 | `user_controller.js` |
286
350
 
287
- ## 应用案例
351
+ ---
288
352
 
289
- - [基于jj.js的轻量博客系统:Melog](https://me.i-i.me/special/melog.html)
353
+ ## 🌟 应用案例
290
354
 
291
- ### Nginx代理
355
+ - **[Melog](https://me.i-i.me/special/melog.html)** - 基于 jj.js 的轻量博客系统
292
356
 
293
- ```
357
+ ---
358
+
359
+ ## 🔧 Nginx 代理配置
360
+
361
+ ```nginx
294
362
  location / {
295
- proxy_pass http://127.0.0.1:3000;
363
+ proxy_pass http://127.0.0.1:3000;
296
364
  proxy_http_version 1.1;
297
365
  proxy_set_header Upgrade $http_upgrade;
298
366
  proxy_set_header Connection "upgrade";
@@ -303,6 +371,8 @@ location / {
303
371
  }
304
372
  ```
305
373
 
306
- ### License
374
+ ---
375
+
376
+ ## 📄 License
307
377
 
308
378
  [MIT](LICENSE)
package/jj.js CHANGED
@@ -1,15 +1,15 @@
1
- /**
2
- * jj.js核心库<br/>
3
- * {App, Cache, Context, Controller, Cookie, Ctx, Db, Logger, Middleware, Model, Pagination, Request, Response, Upload, Url, View, utils, config}
4
- * @module core
5
- * @type {import('./types').Core}
6
- */
7
- module.exports = new Proxy({}, {
8
- get: (target, prop) => {
9
- if(prop in target || typeof prop == 'symbol' || ['inspect', 'router', 'run', 'types'].includes(prop)) {
10
- return target[prop];
11
- }
12
- prop = prop.toLowerCase();
13
- return require(`./lib/${prop == 'utils' ? 'utils/' : ''}${prop}`);
14
- }
1
+ /**
2
+ * jj.js核心库<br/>
3
+ * {App, Cache, Context, Controller, Cookie, Ctx, Db, Logger, Middleware, Model, Pagination, Request, Response, Upload, Url, View, utils, config}
4
+ * @module core
5
+ * @type {import('./types').Core}
6
+ */
7
+ module.exports = new Proxy({}, {
8
+ get: (target, prop) => {
9
+ if(prop in target || typeof prop == 'symbol' || ['inspect', 'router', 'run', 'types'].includes(prop)) {
10
+ return target[prop];
11
+ }
12
+ prop = prop.toLowerCase();
13
+ return require(`./lib/${prop == 'utils' ? 'utils/' : ''}${prop}`);
14
+ }
15
15
  });