docs: add service doc #221

leoner · 2017-01-10T04:23:24Z

Checklist

npm test passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

Description of change

fengmk2 · 2017-01-10T04:47:35Z

docs/source/zh-cn/basics/service.md

+  ```
+
+### 注意事项
+- Service 文件必须放在 `app/services` 目录，可以支持多级目录，访问的时候可以通过目录名级联访问。


单数目录

codecov-io · 2017-01-10T05:43:07Z

Current coverage is 97.78% (diff: 100%)

Merging #221 into master will decrease coverage by 0.10%

@@             master       #221   diff @@
==========================================
  Files            34         34          
  Lines           900        948    +48   
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
+ Hits            881        927    +46   
- Misses           19         21     +2   
  Partials          0          0

Powered by Codecov. Last update 96d5360...5cc1935

popomore · 2017-01-10T07:29:15Z

service 的测试可以链到 unittest

popomore · 2017-01-10T05:25:33Z

docs/source/zh-cn/basics/service.md

+---
+
+# Service
+`Service` 简单来说，就是当遇到一个复杂的业务场景，我们会把这些逻辑封装到一起，作为一个 `Service`，这样可以保持 Controller 的简单，而且也可以保证业务逻辑的独立性， 便于后面的重构和代码重用。


Service 小写，不用代码块

popomore · 2017-01-10T07:23:21Z

docs/source/zh-cn/basics/service.md

+  ```
+
+### 注意事项
+- Service 文件必须放在 `app/services` 目录，可以支持多级目录，访问的时候可以通过目录名级联访问。


popomore · 2017-01-10T07:23:35Z

docs/source/zh-cn/basics/service.md

+  app/services/biz/user.js => this.services.biz.user.find
+  ```
+
+- 一个 Service 文件只能包含一个类， 这个类需要通过 `module.exports` 的方式返回。


popomore · 2017-01-10T07:26:17Z

docs/source/zh-cn/basics/service.md

+// app/services/user.js
+module.exports = app => {
+  class User extends app.Service {
+    constructor(ctx) {


这里这个就可以不写了，定义的时候是让大家知道传 ctx 进来，一般可以不写

popomore · 2017-01-10T07:28:55Z

docs/source/zh-cn/basics/service.md

+
+## Service 的一些场景
+
+- 复杂数据的处理，比如要展现的信息需要从数据库获取，还要经过一定的规则计算，才能返回用户显示。或者计算完成后，更新到数据库。


这部分可能还要细化下， @dead-horse

popomore · 2017-01-10T14:36:19Z

docs/source/zh-cn/basics/service.md

+
+# service
+
+`service` 简单来说，就是当遇到一个复杂的业务场景，我们会把这些逻辑封装到一起，作为一个 `service`。这样可以可以有以下几个好处:


代码块没去掉...

popomore · 2017-01-10T14:38:12Z

docs/source/zh-cn/basics/service.md

+
+`service` 简单来说，就是当遇到一个复杂的业务场景，我们会把这些逻辑封装到一起，作为一个 `service`。这样可以可以有以下几个好处:
+
+- 保持 Controller 中的逻辑更加简洁。


这里都要小写

popomore · 2017-01-10T14:38:23Z

docs/source/zh-cn/basics/service.md

+
+- service 文件必须放在 `app/service` 目录，可以支持多级目录，访问的时候可以通过目录名级联访问。
+
+  ```


popomore · 2017-01-10T14:38:51Z

docs/source/zh-cn/basics/service.md

+为了可以获取用户请求的链路，我们在 Service 中，注入了 ctx, 用户直接可以通过 `this.ctx` 来获取上下文相关信息。比如我们可以用：
+
+- `this.ctx.curl` 发起网络调用
+- `this.ctx.service.otherService` 调用其他 Service


popomore · 2017-01-10T14:39:01Z

docs/source/zh-cn/basics/service.md

+
+### Service ctx 详解
+
+为了可以获取用户请求的链路，我们在 Service 中，注入了 ctx, 用户直接可以通过 `this.ctx` 来获取上下文相关信息。比如我们可以用：


Service 小写

popomore · 2017-01-10T14:39:23Z

docs/source/zh-cn/basics/service.md

+  ```
+
+- 一个 service 文件只能包含一个类， 这个类需要通过 `module.exports` 的方式返回。
+- service 需要通过 Class 的方式定义，父类必须是 app.Service, 其中 app.Service 会在初始化 Service 的时候，传递进来。


app.Service 加代码块

Service 小写

popomore · 2017-01-10T14:39:41Z

docs/source/zh-cn/basics/service.md

+`service` 简单来说，就是当遇到一个复杂的业务场景，我们会把这些逻辑封装到一起，作为一个 `service`。这样可以可以有以下几个好处:
+
+- 保持 Controller 中的逻辑更加简洁。
+- 保持业务逻辑的独立性，抽象出来的 Service 可以被多个 Controller 重复调用。


dead-horse · 2017-01-10T16:38:20Z

docs/source/zh-cn/basics/service.md

+  ```js
+  module.exports = app => {
+    class User extends app.Service {
+      constructor(ctx) {


constructor 可以省略吧

fengmk2

LGTM

dead-horse · 2017-01-11T04:22:58Z

docs/source/zh-cn/basics/service.md

+
+# service
+
+service 简单来说，就是当遇到一个复杂的业务场景，我们会把这些逻辑封装到一起，作为一个 service。这样可以可以有以下几个好处:


这样可以可以有以下几个好处: => 这样有以下几个好处：

简单来说，service 就是在复杂业务场景下用于做业务逻辑封装的一个抽象层。

dead-horse · 2017-01-11T04:24:59Z

docs/source/zh-cn/basics/service.md

+- 保持业务逻辑的独立性，抽象出来的 service 可以被多个 controller 重复调用。
+- 将逻辑和展现分离，更容易编写测试用例，测试用例的编写具体可以查看 [这里](../core/unittest.md)。
+
+## service 的一些场景


## 使用场景

dead-horse · 2017-01-11T04:44:26Z

docs/source/zh-cn/basics/service.md

+  ```js
+  module.exports = app => {
+    class User extends app.Service {
+      * find(uid) {


这里面给一个简单的伪代码例子吧，例如从 db 中查出来

dead-horse · 2017-01-11T04:45:03Z

docs/source/zh-cn/basics/service.md

+  ```
+
+- 一个 service 文件只能包含一个类， 这个类需要通过 `module.exports` 的方式返回。
+- service 需要通过 Class 的方式定义，父类必须是 `app.Service`, 其中 `app.Service` 会在初始化 service 的时候，传递进来。


会在初始化 service 的时候，传递进来。 => 会在初始化 service 的时候通过参数传递进来。

dead-horse · 2017-01-11T04:45:22Z

docs/source/zh-cn/basics/service.md

+
+### Service ctx 详解
+
+为了可以获取用户请求的链路，我们在 service 初始化中，注入了 ctx, 用户在方法中可以通直接过 `this.ctx` 来获取上下文相关信息。关于上下文的具体详解可以参看 [Context](./extend.md#context),


注入了请求上下文

popomore · 2017-01-11T08:48:33Z

这个搞定了么

leoner · 2017-01-11T09:09:39Z

上面说的，应该都改好了，再看下呀。

dead-horse · 2017-01-11T09:28:38Z

docs/source/zh-cn/basics/service.md

+
+### Service ctx 详解
+
+为了可以获取用户请求的链路，我们在 service 初始化中，注入了请求上下文, 用户在方法中可以通直接过 `this.ctx` 来获取上下文相关信息。关于上下文的具体详解可以参看 [Context](./extend.md#context),


通直接过 -> 直接通过

dead-horse · 2017-01-11T09:28:59Z

docs/source/zh-cn/basics/service.md

+为了可以获取用户请求的链路，我们在 service 初始化中，注入了请求上下文, 用户在方法中可以通直接过 `this.ctx` 来获取上下文相关信息。关于上下文的具体详解可以参看 [Context](./extend.md#context),
+有了 ctx 我们可以拿到框架给我们封装的各种便捷属性和方法。比如我们可以用：
+
+- `this.ctx.curl` 发起网络调用


最后一个有句号，前面两行没有

dead-horse · 2017-01-11T09:29:51Z

其他+1

leoner added the type: document label Jan 10, 2017

leoner added this to the v1.x milestone Jan 10, 2017

leoner force-pushed the add-service-doc branch from 3e6a769 to 3c480fa Compare January 10, 2017 04:29

fengmk2 reviewed Jan 10, 2017

View reviewed changes

popomore reviewed Jan 10, 2017

View reviewed changes

leoner force-pushed the add-service-doc branch 3 times, most recently from 4fac2a8 to 15c75ca Compare January 10, 2017 09:15

popomore reviewed Jan 10, 2017

View reviewed changes

leoner force-pushed the add-service-doc branch from 15c75ca to 578fa09 Compare January 10, 2017 14:44

dead-horse reviewed Jan 10, 2017

View reviewed changes

fengmk2 approved these changes Jan 10, 2017

View reviewed changes

leoner force-pushed the add-service-doc branch 2 times, most recently from fa49d54 to 5f0cb9a Compare January 11, 2017 03:26

dead-horse reviewed Jan 11, 2017

View reviewed changes

leoner force-pushed the add-service-doc branch from 5f0cb9a to 5cc1935 Compare January 11, 2017 07:22

dead-horse reviewed Jan 11, 2017

View reviewed changes

docs: add service doc

77dae2f

leoner force-pushed the add-service-doc branch from 5cc1935 to 77dae2f Compare January 11, 2017 15:00

fengmk2 merged commit 1117e52 into master Jan 11, 2017

fengmk2 deleted the add-service-doc branch January 11, 2017 15:35

popomore mentioned this pull request Jan 12, 2017

中文文档 #34

Closed

31 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add service doc #221

docs: add service doc #221

leoner commented Jan 10, 2017

fengmk2 Jan 10, 2017

popomore Jan 10, 2017

codecov-io commented Jan 10, 2017 •

edited

Loading

popomore commented Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

popomore Jan 10, 2017

dead-horse Jan 10, 2017

fengmk2 left a comment

dead-horse Jan 11, 2017

dead-horse Jan 11, 2017

dead-horse Jan 11, 2017

dead-horse Jan 11, 2017

dead-horse Jan 11, 2017

dead-horse Jan 11, 2017

popomore commented Jan 11, 2017

leoner commented Jan 11, 2017

dead-horse Jan 11, 2017

dead-horse Jan 11, 2017

dead-horse commented Jan 11, 2017


		## Service 的一些场景

		- 复杂数据的处理，比如要展现的信息需要从数据库获取，还要经过一定的规则计算，才能返回用户显示。或者计算完成后，更新到数据库。


		# service

		`service` 简单来说，就是当遇到一个复杂的业务场景，我们会把这些逻辑封装到一起，作为一个 `service`。这样可以可以有以下几个好处:


		`service` 简单来说，就是当遇到一个复杂的业务场景，我们会把这些逻辑封装到一起，作为一个 `service`。这样可以可以有以下几个好处:

		- 保持 Controller 中的逻辑更加简洁。


		- service 文件必须放在 `app/service` 目录，可以支持多级目录，访问的时候可以通过目录名级联访问。

		```


		### Service ctx 详解

		为了可以获取用户请求的链路，我们在 Service 中，注入了 ctx, 用户直接可以通过 `this.ctx` 来获取上下文相关信息。比如我们可以用：


		# service

		service 简单来说，就是当遇到一个复杂的业务场景，我们会把这些逻辑封装到一起，作为一个 service。这样可以可以有以下几个好处:


		### Service ctx 详解

		为了可以获取用户请求的链路，我们在 service 初始化中，注入了 ctx, 用户在方法中可以通直接过 `this.ctx` 来获取上下文相关信息。关于上下文的具体详解可以参看 [Context](./extend.md#context),


		### Service ctx 详解

		为了可以获取用户请求的链路，我们在 service 初始化中，注入了请求上下文, 用户在方法中可以通直接过 `this.ctx` 来获取上下文相关信息。关于上下文的具体详解可以参看 [Context](./extend.md#context),

docs: add service doc #221

docs: add service doc #221

Conversation

leoner commented Jan 10, 2017

Checklist

Affected core subsystem(s)

Description of change

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Jan 10, 2017 • edited Loading

Current coverage is 97.78% (diff: 100%)

popomore commented Jan 10, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fengmk2 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

popomore commented Jan 11, 2017

leoner commented Jan 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dead-horse commented Jan 11, 2017

codecov-io commented Jan 10, 2017 •

edited

Loading