typescript-koa-postgresql 實現一個簡單的rest風格伺服器 —— 連線 postgresql 資料庫
阿新 • • 發佈：2018-11-29
接上一篇，這裡使用 sequelize 來連線 postgresql 資料庫
1、安裝 sequelize，資料庫驅動 pg
yarn add sequelize sequelize-typescript pg reflect-metadata
2、新建配置資料夾 conf 及 配置檔案 db.conf.ts
/** * @name: 資料庫配置 * @param : undefined * @return : undefined */ export const dbConfig = { host: 'localhost', database:'demo', dialect: 'postgres', username: 'postgres', password: '123456' }
3、連線資料庫，新建資料夾 db 及 配置檔案 db.ts
1 /* 2 * @Description: 資料庫連線類 3 */ 4 5 import * as path from 'path' 6 import { Sequelize } from 'sequelize-typescript' 7 import { dbConfig } from '../conf/db.conf' 8 9 class DbContext {10 private sequelize: Sequelize 11 constructor() { 12 const { host, database, dialect, username, password } = dbConfig 13 this.sequelize = new Sequelize({ 14 host: host, 15 database: database, 16 dialect: dialect, 17 username: username, 18 password: password,19 define: { 20 timestamps: true, //開啟時間戳 create_at delete_at update_at 21 paranoid: true, //開啟假刪除 22 underscored: true, //下劃線 23 charset: 'utf8', 24 freezeTableName: true //固定表名為單數 預設表名是xxxs 25 }, 26 pool: { 27 max: 10, 28 min: 0, 29 acquire: 30000, 30 idle: 10000 31 }, 32 timezone: '+08:00', 33 modelPaths: [path.resolve(__dirname, `./models`)] 34 }) 35 this.sequelize.sync() 36 } 37 init(): Boolean { 38 return !!this.sequelize 39 } 40 getInstance(): Sequelize { 41 return this.sequelize 42 } 43 isInit(): Boolean { 44 return !!this.sequelize 45 } 46 } 47 export const dbContext = new DbContext()
4、資料庫實體類，新建資料夾 models 及檔案 user.ts
1 /* 2 * @Description: 資料庫實體類 3 */ 4 5 import { Table, Column, Model } from 'sequelize-typescript' 6 7 @Table({ 8 tableName: 'user' 9 }) 10 export default class User extends Model<User> { 11 @Column({ 12 comment: '自增ID', 13 primaryKey: true, 14 autoIncrement: true, 15 }) 16 id: number 17 18 @Column 19 username: string 20 21 @Column 22 password: string 23 }
5、編寫業務邏輯介面，在 src 目錄下新建資料夾 dao、service，在 dao 目錄下新建 UserDao.ts 及子目錄 impl，在 service 目錄下新建 UserService.ts 及子目錄 impl
1 /* 2 * @Description: 資料庫表操作基礎介面 UserDao.ts 3 */ 4 export interface UserDao { 5 /** 6 * @name: 查詢 7 * @param : 8 * @return : Array<User> 9 */ 10 findAll(); 11 /** 12 * @name: 查詢 13 * @param : 14 * @return : Array<User> 15 */ 16 findByName(username:string); 17 /** 18 * @name: 新增 19 * @param : undefined 20 * @return : undefined 21 */ 22 create(entity:UserInfo); 23 24 /** 25 * @name: 刪除 26 * @param : undefined 27 * @return : undefined 28 */ 29 delete(id:number); 30 } 31 export interface UserInfo { 32 username:string; 33 password:string; 34 }
1 /* 2 * @Description: service介面 UserService.ts 3 * @version: 4 */ 5 6 export interface UserService{ 7 /** 8 * @name: 查詢 9 * @param : undefined 10 * @return : undefined 11 */ 12 findAll(); 13 14 /** 15 * @name: 查詢 16 * @param : undefined 17 * @return : undefined 18 */ 19 findByName(username:string); 20 21 /** 22 * @name: 新增 23 * @param : undefined 24 * @return : undefined 25 */ 26 create(username:string,password:string); 27 28 /** 29 * @name: 刪除 30 * @param : undefined 31 * @return : undefined 32 */ 33 delete(id:String); 34 }
6、編寫業務邏輯實現類 UserDaoImpl.ts、UserServiceImpl.ts
1 /* 2 * @Description: 資料庫表操作基礎實現類 UserDaoImpl.ts 3 */ 4 5 import { dbContext } from '../../db/db' 6 import { UserDao, UserInfo } from '../UserDao'; 7 import User from '../../db/models/user'; 8 9 export class UserDaoImpl implements UserDao{ 10 constructor(){ 11 dbContext.init(); 12 } 13 /** 14 * @name: 查詢 15 * @param : undefined 16 * @return : undefined 17 */ 18 public async findAll(){ 19 const results = await User.findAll({ 20 raw: true 21 }) 22 return results; 23 } 24 25 /** 26 * @name: 查詢 27 * @param : undefined 28 * @return : undefined 29 */ 30 public async findByName(username:string){ 31 const results = await User.findOne({ 32 where:{ 33 username:username 34 } 35 }) 36 return results; 37 } 38 39 /** 40 * @name: 新增 41 * @param : entity 42 * @return : undefined 43 */ 44 public async create(entity:UserInfo) { 45 const results = await User.create(entity) 46 return results; 47 } 48 49 /** 50 * @name: 刪除 51 * @param : undefined 52 * @return : undefined 53 */ 54 public async delete(id: number) { 55 const results = await User.destroy({ 56 where:{ 57 id:{ 58 $eq:id 59 } 60 } 61 }); 62 return results; 63 } 64 }
1 import { UserService } from "../UserService"; 2 import { UserDao } from "../../dao/UserDao"; 3 import { UserDaoImpl } from "../../dao/impl/UserDaoImpl"; 4 5 /* 6 * @Description: service實現類 UserServiceImpl.ts 7 */ 8 9 10 export class UserServiceImpl implements UserService{ 11 private userDao:UserDao; 12 13 constructor(){ 14 this.userDao = new UserDaoImpl(); 15 } 16 17 /** 18 * @name: 查詢 19 * @param : undefined 20 * @return : undefined 21 */ 22 public findAll() { 23 return this.userDao.findAll(); 24 } 25 /** 26 * @name: 查詢 27 * @param : undefined 28 * @return : undefined 29 */ 30 public findByName(username:string) { 31 return this.userDao.findByName(username); 32 } 33 /** 34 * @name: 新增 35 * @param : entity 36 * @return : undefined 37 */ 38 public create(username: string, password: string) { 39 return this.userDao.create({username,password}); 40 } 41 42 /** 43 * @name: 刪除 44 * @param : undefined 45 * @return : undefined 46 */ 47 public delete(id: String) { 48 return this.userDao.delete(~~id); 49 } 50 51 }
7、檢視成果，修改 router/index.ts
1 /* 2 * @Description: 後臺路由元件 3 * @version: 0.1.0 4 */ 5 import * as Router from 'koa-router'; 6 import { UserInfo } from '../dao/UserDao'; 7 import { UserService } from '../service/UserService'; 8 import { UserServiceImpl } from '../service/impl/UserServiceImpl'; 9 10 const router = new Router(); 11 const userService:UserService =new UserServiceImpl(); 12 13 router.get('/*', async (ctx) => { 14 ctx.body = await userService.findAll(); 15 }) 16 17 export { router }
8、瀏覽器輸入 http://localhost:8080
至此連線資料庫完成
目錄結構：
