koa는 Express와 유사한 Node 기반의 웹 프레임워크를 말하며, 웹 애플리케이션 및 API 개발 분야에서 더 작고, 더 표현력이 풍부하며, 더 강력한 초석이 되기 위해 노력하고 있습니다. Koa는 미들웨어를 번들로 제공하지 않지만 사용자가 서버 측 애플리케이션을 빠르고 즐겁게 작성할 수 있도록 돕는 우아한 방법 세트를 제공합니다.
이 튜토리얼의 운영 환경: windows7 시스템, nodejs 버전 12.19.0&&koa2.0, Dell G3 컴퓨터.
Koa
는 Express와 유사한 웹 개발 프레임워크입니다. 창립자도 동일합니다. 주요 특징은 <code>ES6 생성기 기능
을 사용하고 아키텍처를 재설계한다는 것입니다. 즉, Koa의 원리와 내부 구조는 Express와 매우 유사하지만 구문과 내부 구조가 업그레이드되었습니다. Koa
是一个类似于Express的Web
开发框架,创始人也是同一个人。它的主要特点是,使用了ES6的Generator函数
,进行了架构的重新设计。也就是说,Koa的原理和内部结构很像Express,但是语法和内部结构进行了升级。
Koa 是一个新的 web 框架,由 Express 幕后的原班人马打造, 致力于成为 web 应用和 API 开发领域中的一个更小、更富有表现力、更健壮的基石。 通过利用 async 函数,Koa 帮你丢弃回调函数,并有力地增强错误处理。 Koa 并没有捆绑任何中间件, 而是提供了一套优雅的方法,帮助您快速而愉快地编写服务端应用程序。
官方faq
有这样一个问题:”为什么koa不是Express 4.0?“,回答是这样的:”Koa与Express有很大差异,整个设计都是不同的,所以如果将Express 3.0按照这种写法升级到4.0,就意味着重写整个程序。所以,我们觉得创造一个新的库,是更合适的做法。“
一个Koa应用
就是一个对象
,包含了一个middleware
数组,这个数组由一组Generator函数
组成。这些函数负责对HTTP请求进行各种加工,比如生成缓存、指定代理、请求重定向等等。
var koa = require('koa'); var app = koa(); app.use(function *(){ this.body = 'Hello World'; }); app.listen(3000);
Hello World
的网页。app.use
方法用于向middleware
数组添加Generator函数
。listen
方法指定监听端口,并启动当前应用。var http = require('http'); var koa = require('koa'); var app = koa(); http.createServer(app.callback()).listen(3000);
Koa
的中间件很像Express的中间件
,也是对HTTP请求进行处理的函数
,但是必须是一个Generator函数
。
而且,Koa的中间件是一个级联式(Cascading)
的结构,也就是说,属于是层层调用,第一个中间件调用第二个中间件
,第二个调用第三个
,以此类推。上游的中间件必须等到下游的中间件返回结果
,才会继续执行,这点很像递归。
中间件通过当前应用的use
方法注册。
app.use(function* (next){ var start = new Date; // (1) yield next; // (2) var ms = new Date - start; // (3) console.log('%s %s - %s', this.method, this.url, ms); // (4) });
上面代码中,app.use
方法的参数就是中间件,它是一个Generator函数
, 最大的特征就是function命令
与参数之间,必须有一个星号
。Generator函数的参数next
,表示下一个中间件。Generator
函数内部使用yield
命令,将程序的执行权转交给下一个中间件,即yield next
,要等到下一个中间件返回结果,才会继续往下执行。
Generator函数体内部
,第一行赋值语句首先执行,开始计时,yield
语句将执行权交给下一个中间件,当前中间件就暂停执行app.use(function *() { this.body = "header\n"; yield saveResults.call(this); this.body += "footer\n"; }); function *saveResults() { this.body += "Results Saved!\n"; }
上面代码中,第一个中间件调用第二个中间件saveResults,它们都向this.body写入内容。最后,this.body的输出如下。
header Results Saved! footer
只要有一个中间件缺少yield next
语句,后面的中间件都不会执行,这一点要引起注意。
app.use(function *(next){ console.log('>> one'); yield next; console.log('<< one'); }); app.use(function *(next){ console.log('>> two'); this.body = 'two'; console.log('<< two'); }); app.use(function *(next){ console.log('>> three'); yield next; console.log('<< three'); });
上面代码中,因为第二个中间件少了yield next
语句,第三个中间件并不会执行。
如果想跳过一个中间件,可以直接在该中间件的第一行语句写上return yield next。
app.use(function* (next) { if (skip) return yield next; })
由于Koa要求中间件唯一的参数就是next
,导致如果要传入其他参数,必须另外写一个返回Generator函数
Koa는 Express를 개발한 사람들이 만든 새로운 웹 프레임워크로, 웹 애플리케이션과 API 개발의 더 작고 표현력이 풍부하며 강력한 초석이 되기 위해 노력하고 있습니다. Koa는 비동기 기능을 활용하여 콜백 기능을 폐기하고 오류 처리를 크게 향상시킵니다. Koa는 미들웨어를 번들로 제공하지 않지만, 서버 측 애플리케이션을 빠르고 즐겁게 작성하는 데 도움이 되는 우아한 방법 세트를 제공합니다.
공식 faq
에 "koa는 Express 4.0이 아닌 이유는 무엇입니까?"라는 질문이 있고, 대답은 다음과 같습니다. "Koa는 Express와 매우 다르며 전체 디자인도 다릅니다. 따라서 이런 식으로 Express 3.0을 4.0으로 업그레이드한다면 전체 프로그램을 다시 작성한다는 의미이므로 새로운 라이브러리를 만드는 것이 더 적절하다고 생각합니다. "
Koa 애플리케이션
은 생성기 함수
세트로 구성된 미들웨어
배열을 포함하는 객체
입니다. 코드> >구성. 이러한 기능은 캐시 생성, 프록시 지정, 요청 리디렉션 등과 같은 다양한 HTTP 요청 처리를 담당합니다. 🎜function logger(format) { return function *(next){ var str = format .replace(':method', this.method) .replace(':url', this.url); console.log(str); yield next; } } app.use(logger(':method :url'));
Hello World
콘텐츠가 포함된 웹페이지를 반환합니다. app.use
메소드는 미들웨어
배열에 Generator 함수
를 추가하는 데 사용됩니다. listen
메소드는 수신 포트를 지정하고 현재 애플리케이션을 시작합니다. function *random(next) { if ('/random' == this.path) { this.body = Math.floor(Math.random()*10); } else { yield next; } }; function *backwards(next) { if ('/backwards' == this.path) { this.body = 'sdrawkcab'; } else { yield next; } } function *pi(next) { if ('/pi' == this.path) { this.body = String(Math.PI); } else { yield next; } } function *all(next) { yield random.call(this, backwards.call(this, pi.call(this, next))); } app.use(all);
Koa
의 미들웨어는 Express의 미들웨어
와 매우 유사하며 right HTTP 요청을 처리하는 함수
이지만 생성기 함수
여야 합니다. Cascading
구조, 즉 레이어별로 호출됩니다. 첫 번째 미들웨어가 두 번째 미들웨어를 호출합니다
. code>두 번째가 세 번째를 호출하는 식입니다. 업스트림 미들웨어는 실행을 계속하기 전에 다운스트림 미들웨어가 결과를 반환할 때까지 기다려야 합니다
. 이는 재귀와 매우 유사합니다. use
메소드를 통해 등록됩니다. 🎜function compose(middleware){ return function *(next){ if (!next) next = noop(); var i = middleware.length; while (i--) { next = middleware[i].call(this, next); } yield *next; } } function *noop(){}
app.use
메소드의 매개변수는 Generator 함수
인 미들웨어입니다. 가장 큰 특징은 입니다. >기능 명령< /code>와 매개변수 사이에 <code>에는 별표
🎜가 있어야 합니다. Generator 함수 next
의 매개변수는 다음 미들웨어를 나타냅니다. Generator
함수는 내부적으로 yield
명령을 사용하여 프로그램의 실행권한을 다음 미들웨어, 즉 yield next
에 넘겨줍니다. >. 다음 미들웨어가 결과를 반환할 때만 실행이 계속됩니다. 🎜Generator 함수 본문
내부에서는 할당문의 첫 번째 줄이 먼저 실행되고 타이밍이 시작됩니다. app.use(function* (next) { if (this.path === '/') { this.body = 'we are at home!'; } }) // 等同于 app.use(function* (next) { if (this.path !== '/') return yield next; this.body = 'we are at home!'; })
let koa = require('koa') let app = koa() // normal route app.use(function* (next) { if (this.path !== '/') { return yield next } this.body = 'hello world' }); // /404 route app.use(function* (next) { if (this.path !== '/404') { return yield next; } this.body = 'page not found' }); // /500 route app.use(function* (next) { if (this.path !== '/500') { return yield next; } this.body = 'internal server error' }); app.listen(8080)
yield next
문이 없으면 후속 미들웨어는 실행되지 않습니다. 🎜var app = require('koa')(); var Router = require('koa-router'); var myRouter = new Router(); myRouter.get('/', function *(next) { this.response.body = 'Hello World!'; }); app.use(myRouter.routes()); app.listen(3000);
yield next
문이 없기 때문에 세 번째 미들웨어는 실행되지 않습니다. router.get('/', function *(next) { this.body = 'Hello World!'; });
Koa에서는 미들웨어의 유일한 매개변수가 다음 매개변수여야 하므로
, 다른 매개변수를 전달하려면 Generator 함수
를 반환하는 다른 함수를 작성해야 합니다. 코드>. 🎜🎜router.get('user', '/users/:id', function *(next) { // ... });
由于中间件的参数统一为next
(意为下一个中间件),因此可以使用.call(this, next)
,将多个中间件进行合并。
function *random(next) { if ('/random' == this.path) { this.body = Math.floor(Math.random()*10); } else { yield next; } }; function *backwards(next) { if ('/backwards' == this.path) { this.body = 'sdrawkcab'; } else { yield next; } } function *pi(next) { if ('/pi' == this.path) { this.body = String(Math.PI); } else { yield next; } } function *all(next) { yield random.call(this, backwards.call(this, pi.call(this, next))); } app.use(all);
上面代码中,中间件all内部,就是依次调用random、backwards、pi,后一个中间件就是前一个中间件的参数。
Koa内部使用koa-compose
模块,进行同样的操作,下面是它的源码。
function compose(middleware){ return function *(next){ if (!next) next = noop(); var i = middleware.length; while (i--) { next = middleware[i].call(this, next); } yield *next; } } function *noop(){}
上面代码中,middleware是中间件数组。前一个中间件的参数是后一个中间件,依次类推。如果最后一个中间件没有next参数,则传入一个空函数。
可以通过this.path属性,判断用户请求的路径,从而起到路由作用。
app.use(function* (next) { if (this.path === '/') { this.body = 'we are at home!'; } }) // 等同于 app.use(function* (next) { if (this.path !== '/') return yield next; this.body = 'we are at home!'; })
下面是多路径的例子。
let koa = require('koa') let app = koa() // normal route app.use(function* (next) { if (this.path !== '/') { return yield next } this.body = 'hello world' }); // /404 route app.use(function* (next) { if (this.path !== '/404') { return yield next; } this.body = 'page not found' }); // /500 route app.use(function* (next) { if (this.path !== '/500') { return yield next; } this.body = 'internal server error' }); app.listen(8080)
上面代码中,每一个中间件负责一个路径,如果路径不符合,就传递给下一个中间件。
复杂的路由需要安装koa-router插件。
var app = require('koa')(); var Router = require('koa-router'); var myRouter = new Router(); myRouter.get('/', function *(next) { this.response.body = 'Hello World!'; }); app.use(myRouter.routes()); app.listen(3000);
上面代码对根路径设置路由。
Koa-router实例提供一系列动词方法,即一种HTTP动词对应一种方法。典型的动词方法有以下五种。
路径模式
,第二个是对应的控制器方法
(中间件),定义用户请求该路径时服务器行为。router.get('/', function *(next) { this.body = 'Hello World!'; });
上面代码中,router.get
方法的第一个参数是根路径,第二个参数是对应的函数方法。注意
,路径匹配的时候,不会把查询字符串考虑在内。比如,/index?param=xyz匹配路径/index。
有些路径模式比较复杂,Koa-router允许为路径模式起别名。
起名时,别名要添加为动词方法的第一个参数,这时动词方法变成接受三个参数。
router.get('user', '/users/:id', function *(next) { // ... });
上面代码中,路径模式\users\:id
的名字就是user
。路径的名称,可以用来引用对应的具体路径,比如url方法可以根据路径名称,结合给定的参数,生成具体的路径。
router.url('user', 3); // => "/users/3" router.url('user', { id: 3 }); // => "/users/3"
上面代码中,user就是路径模式的名称,对应具体路径/users/:id。url方法的第二个参数3,表示给定id的值是3,因此最后生成的路径是/users/3。
Koa-router允许为路径统一添加前缀。
var router = new Router({ prefix: '/users' }); router.get('/', ...); // 等同于"/users" router.get('/:id', ...); // 等同于"/users/:id"
路径的参数通过this.params
属性获取,该属性返回一个对象,所有路径参数都是该对象的成员。
// 访问 /programming/how-to-node router.get('/:category/:title', function *(next) { console.log(this.params); // => { category: 'programming', title: 'how-to-node' } }); param方法可以针对命名参数,设置验证条件。 router .get('/users/:user', function *(next) { this.body = this.user; }) .param('user', function *(id, next) { var users = [ '0号用户', '1号用户', '2号用户']; this.user = users[id]; if (!this.user) return this.status = 404; yield next; })
上面代码中,如果/users/:user
的参数user对应的不是有效用户(比如访问/users/3),param方法注册的中间件会查到,就会返回404错误。
redirect方法会将某个路径的请求,重定向到另一个路径,并返回301状态码。
router.redirect('/login', 'sign-in'); // 等同于 router.all('/login', function *() { this.redirect('/sign-in'); this.status = 301; });
redirect方法的第一个参数是请求来源,第二个参数是目的地,两者都可以用路径模式的别名代替。
this
表示上下文对象context
,代表一次HTTP请求和回应
,即一次访问/回应的所有信息,都可以从上下文对象获得。app.use(function *(){ this; // is the Context this.request; // is a koa Request this.response; // is a koa Response });
context
对象的很多方法,其实是定义在ctx.request对象或ctx.response对象上面
比如,ctx.type
和ctx.length
对应于ctx.response.type
和ctx.response.length
,ctx.path和ctx.method对应于ctx.request.path和ctx.request.method。
context对象的全局属性。
this.state.user = yield User.find(id);
上面代码中,user
属性存放在this.state
对象上面,可以被另一个中间件读取。
context对象的全局方法。
this.throw(403); this.throw('name required', 400); this.throw('something exploded'); this.throw(400, 'name required'); // 等同于 var err = new Error('name required'); err.status = 400; throw err;
Koa提供内置的错误处理机制,任何中间件抛出的错误都会被捕捉到,引发向客户端返回一个500
错误,而不会导致进程停止,因此也就不需要forever这样的模块重启进程。
app.use(function *() { throw new Error(); });
上面代码中,中间件内部抛出一个错误,并不会导致Koa应用挂掉。Koa内置的错误处理机制,会捕捉到这个错误。
当然,也可以额外部署自己的错误处理机制。
app.use(function *() { try { yield saveResults(); } catch (err) { this.throw(400, '数据无效'); } });
上面代码自行部署了try...catch
代码块,一旦产生错误,就用this.throw
方法抛出。该方法可以将指定的状态码和错误信息,返回给客户端。
对于未捕获错误,可以设置error事件的监听函数。
app.on('error', function(err){ log.error('server error', err); });
error
事件的监听函数还可以接受上下文对象,作为第二个参数。
app.on('error', function(err, ctx){ log.error('server error', err, ctx); });
如果一个错误没有被捕获,koa会向客户端返回一个500错误“Internal Server Error”。this.throw
方法用于向客户端抛出一个错误。
this.throw(403); this.throw('name required', 400); this.throw(400, 'name required'); this.throw('something exploded'); this.throw('name required', 400) // 等同于 var err = new Error('name required'); err.status = 400; throw err; this.throw方法的两个参数,一个是错误码,另一个是报错信息。如果省略状态码,默认是500错误。 this.assert方法用于在中间件之中断言,用法类似于Node的assert模块。 this.assert(this.user, 401, 'User not found. Please login!');
上面代码中,如果this.user属性不存在,会抛出一个401错误。
由于中间件是层级式调用,所以可以把try { yield next }
当成第一个中间件。
app.use(function *(next) { try { yield next; } catch (err) { this.status = err.status || 500; this.body = err.message; this.app.emit('error', err, this); } }); app.use(function *(next) { throw new Error('some error'); })
cookie的读取和设置。
this.cookies.get('view'); this.cookies.set('view', n);
get和set
方法都可以接受第三个参数,表示配置参数。其中的signed
参数,用于指定cookie
是否加密。
如果指定加密的话,必须用app.keys指定加密短语。
app.keys = ['secret1', 'secret2']; this.cookies.set('name', '张三', { signed: true });
this.cookie的配置对象的属性如下。
signed
:cookie是否加密。expires
:cookie何时过期path
:cookie的路径,默认是“/”。domain
:cookie的域名。secure
:cookie是否只有https请求下才发送。httpOnly
:是否只有服务器可以取到cookie,默认为true。var session = require('koa-session'); var koa = require('koa'); var app = koa(); app.keys = ['some secret hurr']; app.use(session(app)); app.use(function *(){ var n = this.session.views || 0; this.session.views = ++n; this.body = n + ' views'; }) app.listen(3000); console.log('listening on port 3000');
【推荐学习:《nodejs 教程》】
위 내용은 nodejs에서 Koa는 무엇입니까?의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!