Node.js 위에 기본적으로 Express.js 를 많이 사용하지만 좀 더 추상화 되고 MVC 다운 프레임워크를 사용해 보고자. Express.js 및 Socket.io 와 다양한 데이터베이스를 추상화해서 사용할 수 있는 기능을 갖춘 Sails.js Framework을 사용해 보도록 한다.
1. 사용 배경
- Enterprise 급 MVC Framework : Express.js + Socket.io 기본 설정되어 사용
- Waterline 이라는 adapter를 통하여 다양한 Database의 호환성 보장
+ 흐름 : Model 객체 <-> Waterline <-> Databases
+ 지원 데이터베이스 : MySql, PostgreSql, MongoDB, etc
+ 데이터베이스 연결을 하지 않으면 파일 또는 디스크에 백만개 밑으로 key:value 저장하는 node-dirty 의 어뎁터를 사용한다
- 손쉬운 설치 및 RESTful Web Services 개발
- socket.io 및 redis 통합
- SPA (Single Page Application) 개발을 위한 client framework (backbone, ember, angular)의 adapter 제공
+ Yeoman generator 제공 : Generator Sails AngularJS
2. 설치 및 사용
- Yeoman을 기본 설치한다 : Yeoman 이해와 설치하기
- "generator-sails-angular" 설치 후 "yo" 명령수행 : 빨간색의 Sails-angular 선택 (주의, sails 0.9.4 버전과 호환안됨 )
// generator 설치
$ sudo npm install -g generator-sails-angular generator-angular
// yeoman 명령 수행
$ yo
[?] What would you like to do? (Use arrow keys)
❯ Run the Angular generator (0.3.1)
Run the Backbone generator (0.1.7)
Run the Bootstrap generator (0.1.3)
Run the Express generator (0.1.0)
Run the Generator generator (0.2.0)
Run the Mocha generator (0.1.1)
Run the Sails-angular generator (0.0.1)
Update your generators
Install a generator
Find some help
Get me out of here!
// 선택을 하면 Server에 Sails 환경과 Client에 AngularJS 환경이 동시에 설정된다
// Client는 기본 Twitter bootstrap을 사용하고 Client 추가 Component는 "bower install <Component명칭>" 을 사용하여 설치한다
// Server는 "npm install <module명칭>"을 사용하여 설치한다
- "sails lift" 수행 (2013.09.23현재 0.9.4 버전으로 sails upgrade : sudo npm update sails -g )
$ sails lift
info:
info:
info: Sails.js <|
info: v0.9.4 |\
info: /|.\
info: / || \
info: ,' |' \
info: .-'.-==|/_--'
info: `--'-------'
info: __---___--___---___--___---___--___
info: ____---___--___---___--___---___--___-__
info:
info: Server lifted in `/Users/prototyping/sails/test`
info: To see your app, visit http://localhost:1337
info: To shut down Sails, press <CTRL> + C at any time.
debug: --------------------------------------------------------
debug: :: Mon Sep 23 2013 10:05:04 GMT+0900 (KST)
debug:
debug: Environment : development
debug: Port : 1337
debug: --------------------------------------------------------
3. Sails MVC 이해하기
- Model
+ Waterline 이라는 Sails Adapter를 통하여 다양한 데이터베이스의 객체로 사용되어 진다
+ 단, Waterline의 형식(JSON 포멧)에 맞추어서 Model을 정의한다 : 모든 데이터베이스에 추상화된 정의이다
+ /config/adapters.js 파일에 Database 환경 설정을 한다 또한 관련 데이터 베이스 adapter를 설치해야 함
예) MongoDB 설치
$ npm install sails-mongo --save
npm http 200 https://registry.npmjs.org/sails-mongo
npm http GET https://registry.npmjs.org/sails-mongo/-/sails-mongo-0.9.5.tgz
.. 중략 ..
+ /api/models/ 디렉토리 밑에 <Model>.js 파일이 위치한다
// model 생성
$ sails generate model Person
// 생성 내역 : Model의 맨앞자는 자동으로 대문자로 변경됨
$ /api/models> cat Person.js
/*---------------------
---------------------*/
module.exports = {
: {
type: 'STRING',
defaultValue: '555-555-5555'
};/
// CRUD : 기본 Deferred Promised 지원
생성 : Person.create
조회 : Person.findOne/find
갱신 : Person.update
제거 : Person.destroy
- Controller
+ view와 model 사이의 제어 역할을 한다
+ /api/controllers/ 디렉토리에 위치함
// comment controller 만들기 : 최종 명령 tag뒤에 스페이스가 있으면 안된다.
// controller 뒤 첫번째 인자 : comment가 controller의 명칭
// controller 두번째 인자이후 : comment의 메소드 명칭들 열거
$ sails generate controller comment create like tag
// 결과
$ /api/controllers> cat CommentController.js
/*---------------------
---------------------*/
var CommentController = {
create : function (req,res) {
like : function (req,res) {
tag : function (req,res) {
};
module.exports = CommentController;
// 브라우져 호출
http://localhost:1337/comment /create (like, tag)
- Route
+ RESTful 호출을 uri를 제어하고 싶다면 Route를 지정한다
+ /config/routes.js 파일안에 정의한다
+ controller와 action을 정의한다
+ home의 경우
1) /config/routes.js 에 하기와 같이 home 컨트롤러 정의
2) /api/controllers/HomeController.js 존재 : index액션(펑션) 존재
3) /views/home/index.ejs 파일 존재 : 서버에서 rendering되어 클라이언트 응답
// Routes
// *********************
//
// This table routes urls to controllers/actions.
//
// If the URL is not specified here, the default route for a URL is: /:controller/:action/:id
// where :controller, :action, and the :id request parameter are derived from the url
//
// If :action is not specified, Sails will redirect to the appropriate action
// based on the HTTP verb: (using REST/Backbone conventions)
//
// action을 정의하지 않으면 다음의 기본 형식을 따른다
// GET: /:controller/read/:id
// POST: /:controller/create
// PUT: /:controller/update/:id
// DELETE: /:controller/destroy/:id
//
// If the requested controller/action doesn't exist:
// - if a view exists ( /views/:controller/:action.ejs ), Sails will render that view
// - if no view exists, but a model exists, Sails will automatically generate a
// JSON API for the model which matches :controller.
// - if no view OR model exists, Sails will respond with a 404.
//
module.exports.routes = {
: 'home'
controller : 'user',
action : 'signup'
'get /user': {
controller : 'user',
action : 'index'
},
'get /user/:id': {
controller : 'user',
action : 'find'
},
'post /user': {
controller : 'user',
action : 'create'
},
'put /user/:id': {
controller : 'user',
action : 'update'
},
'delete /user/:id': {
controller : 'user',
action : 'destroy'
}
};
- View
+ Sails는 기본 ejs를 사용한다
+ /views/ 밑에 위치한다
+ Partial 파일을 include 할 수 있다
+ 메인 파일 : layout.ejs
- Adapter
+ 데이터베이스를 바꾸고 싶다면 /config/adapters.js 에서 내용을 바꾼다 : MongoDB를 사용한다면 mongo adapter를 설치해야 한다
// Configure installed adapters
// If you define an attribute in your model definition,
// it will override anything from this global config.
module.exports.adapters = {
'default': 'memory',
// Sails-dirty 는 Node-Dirty의 Adapter를 memory or disk에 JSON 을 저장하는 store이다. 백만개 밑으로 저장시 사용
sails-dirty ',
because of limitations in node-dirty
See https://github.com/felixge/node-dirty/issues/34
module: 'sails-dirty' ,
module : 'sails-mysql' ,
: 'YOUR_MYSQL_SERVER_HOSTNAME_OR_IP_ADDRESS',
: 'YOUR_MYSQL_USER',
: 'YOUR_MYSQL_PASSWORD',
: 'YOUR_MYSQL_DB'
};
+ generator-sails-angular 를 yeoman통하여 설치하였다면 SPA를 개발하는 것이므로 실제로 ejs 쓸 일이 거의 없고, Client 단에서 AngularJS 정의에 따라 Routing과 View Control이 발생한다. 따라서 Controller를 통하여 수행할 action에서 response.view() 하는 것이 아니라, response.json(<JSON Object>) 만을 응답으로 주면 될 것으로 보인다. 또한 업무적인 처리는 action에서 구현하면 된다
+ response.send(형식)
res.send(); // 204
res.send(new Buffer('wahoo'));
res.send({ some: 'json' });
res.send('<p>some html</p>');
res.send('Sorry, cant find that', 404);
res.send('text', { 'Content-Type': 'text/plain' }, 201);
res.send(404);
+ response.json(형식)
res.json(null);
res.json({ user: 'tj' });
res.json('oh noes!', 500);
res.json('I dont have that', 404);
* Redis나 데이터베이스의 외부 인터페이스 라이브러리는 Custom Adapter 개발을 수행한다. (만드는 방법 )
3. MongoDB 연결하여 RESTful 호출 테스트
- mongodb 환경설정 : sails-mongo 어뎁터가 설치되어 있어야 함
$ cd config && vi adapters.js 이동하여 mongodb 설정 입력
////////////////////////
// adapters.js 수정 내역
module.exports.adapters = {
// If you leave the adapter config unspecified
// in a model definition, 'default' will be used.
'default': 'mongo ',
// In-memory adapter for DEVELOPMENT ONLY
memory: {
module: 'sails-memory'
},
// Persistent adapter for DEVELOPMENT ONLY
// (data IS preserved when the server shuts down)
disk: {
module: 'sails-disk'
},
// sails v.0.9.0
mongo : {
module : 'sails-mongo',
host : 'localhost',
port : 27017,
user : '',
password : '',
database : 'sailsdb'
}
};
- Person model 수정
// ProjectName/models/Person.js 수정 내역
module.exports = {
attributes: {
}
};
- PersonController의 create 수정 : Promise 구문 형식 사용가능
// ProjectName/controllers/PersonController.js 수정 내역
module.exports = {
create: function (req,res) {
Person.create({
name: req.param('name'),
phone: req.param('phone'),
address: req.param('address'),
sex: req.param('sex'),
etc: req.param('etc')
}).done(function(err, person){
if(err) throw err;
res.json(person);
});
},
.. 중략 ..
}
- Postman을 통하여 호출 테스트 : Postman chrome extension 을 설치한다.
- mongo shell 에서 person collection 조회 : model이 mongodb에서 collection과 맵핑된다
///////////////////
// mongo shell 확인
$ mongo
MongoDB shell version: 2.4.5
connecting to: test
> show dbs
local 0.078125GB
sailsdb 0.203125GB
> use sailsdb
switched to db sailsdb
> show collections
person
system.indexes
> db.person.find();
{ "name" : "도원", "phone" : "1004", "address" : "seoul", "sex" : "man", "etc" : "developer", "createdAt" : ISODate("2013-09-23T02:28:51.281Z"), "updatedAt" : ISODate("2013-09-23T02:28:51.281Z"), "_id" : ObjectId("523fa76377e9f89562000001") }
4. MongoDB의 _id를 sequence number로 바꾸기
- "_id" : ObjectId("523fa76377e9f89562000001") 라고 나오는 것을 "_id" : 1 씩 증가하는 정수로 바꾸기
- 최대한 sails-mongo adapter의 api를 사용하여 구현한다
- sequence document 만들기
> db.seq.insert(
{
_id: 'personid',
seq: 0
});
> db.seq.find();
{ "_id" : "personid", "seq" : 0 }
- Sails Model을 정의한다
$ sails generate model seq
$ cd models && vi Seq.js
// Seq.js 내역
// _id를 통하여 여러 model의 sequence 값을 구분하기 위해 사용한다
module.exports = {
attributes: {
_id: 'string',
seq: 'integer'
}
};
- Person의 모델에서 명시적으로 _id 를 integer로 정의한다
module.exports = {
attributes: {
_id: 'integer',
}
};
- PersonController.js 내역 수정 : Gist 소스 파일
/**
* /person/create
*/
create: function (req,res) {
// seq 번호를 얻어온다
Seq.find({_id: 'personid'}) .done(function(err, seqObj) {
if(err) throw err;
// 배열임을 주의
var seqNo = seqObj[0].seq;
seqNo++;
console.log('>>> seqNo is', seqNo);
// insert시에 _id 값을 넣어준다
Person.create({
_id: seqNo,
name: req.param('name'),
phone: req.param('phone'),
address: req.param('address'),
sex: req.param('sex'),
etc: req.param('etc')
}).done(function(err, person){
if(err) throw err;
res.json(person);
});
// sails-mongo의 api에 한번에 select & update해주는 findAndModify 메소드가 없는 관계로 seqNo를 update해준다
Seq.update({_id: 'personid'}, {seq: seqNo}) .done(function(err, seqObj){
if(err) throw err;
})
});
},
- Postman으로 테스트 데이터를 입력한다
- mongo shell로 mongodb에 저장된 내역을 확인해 보자
// postman통하여 데이터를 2개 넣었을 경우
> db.seq.find();
{ "_id" : "personid", "seq" : 2 , "updatedAt" : ISODate("2013-09-23T09:47:29.548Z") }
> db.person.find();
{ "_id" : 1 , "name" : "윤도원-8", "phone" : "1004", "address" : "목동", "sex" : "사람", "etc" : "모비콘 블로깅", "createdAt" : ISODate("2013-09-23T09:45:36.391Z"), "updatedAt" : ISODate("2013-09-23T09:45:36.391Z") }
{ "_id" : 2 , "name" : "윤도원-9", "phone" : "1004", "address" : "목동", "sex" : "사람", "etc" : "모비콘 블로깅", "createdAt" : ISODate("2013-09-23T09:47:29.547Z"), "updatedAt" : ISODate("2013-09-23T09:47:29.547Z") }
>
5. Sails를 통항 WebApp 만들기
- SailsCast Site 참조
- SailsCast GitHub 소스
- 유튜브 동영상 25 강좌 보기
VIDEO
<참조>
- Sails.js + AngularJS + MongoDB 데모
- MongoDB auto increment Sequence Field 방법
- Mongoose Sequence Table 통한 auto increment plugin : express 와 mongoose 사용시 해당 plugin을 사용
