完成第一支 Web API

進入正題

Day 30 中,我們已將大量的程式碼都實作完成了,只剩下:
  • controllers/Usercontroller.ts
  • controllers/models/Database.ts
需要完成。

controllers/models/Database.ts

相較 UsercontrollerDatabase 封裝了更底層的邏輯,它直面了整個社會被用來建立與資料庫的連結:
1
import { MongoClient } from "https://deno.land/x/[email protected]/mod.ts";
2
3
export class DatabaseController {
4
private client;
5
constructor() {
6
this.client = new MongoClient();
7
this.client.connectWithUri("mongodb://localhost:27017");
8
}
9
initModels(database) {
10
return this.client.database(database);
11
}
12
}
Copied!
由於筆者實作的是極簡易版的 Web API ,在該物件中只存在一個方法: initModels()
Class::DatabaseController 被實例化時, constructor() 就已經與 mongoDB 建立連線,而 initModels 只是用來選定使用者希望連線的資料庫。
controllers/UserController.ts
在完成 Database 連線邏輯的封裝後,我們進一步來看看 UserController 的實作:
1
import { DatabaseController } from "./models/Database.ts";
2
const dataBase = await new DatabaseController().initModels("test");
3
const collection = dataBase.collection("data");
4
5
export class userController {
6
findOne(props:any){
7
return collection.findOne({"name":`${props}`});
8
}
9
insertData(props:any){
10
collection.insertOne({
11
name:`${props}`
12
})
13
}
14
}
Copied!
UserController.ts 負責接收路由的請求並根據請求對資料庫進行操作,所以都會跟 Route.ts 內的路由相對應:
1
import { Router, Status, RouterContext } from "https://deno.land/x/oak/mod.ts";
2
import { userController } from "../controllers/UserController.ts";
3
const controller = new userController();
4
export function UserRoutes(router: Router) {
5
return router
6
.get("/user/:id", async (ctx: RouterContext) => {
7
const users = await controller.findOne(ctx.params.id);
8
if (users) {
9
ctx.response.status = Status.OK;
10
ctx.response.body = users;
11
12
} else {
13
ctx.response.status = Status.NotFound;
14
ctx.response.body = [];
15
}
16
})
17
.post("/insert", async(ctx: RouterContext)=>{
18
const { name } = await ctx.request.body;
19
if(name){
20
await controller.insertData(name)
21
ctx.response.status = Status.OK;
22
ctx.response.body = 'Success!'
23
}
24
})
25
}
Copied!

完整原始碼

完整原始碼都已經上傳到 github 上,如果讀者有需要可以自行取用。

補充: ORM

物件關聯對映(英語:Object Relational Mapping,簡稱ORM,或O/RM,或O/R mapping),是一種程式設計技術,用於實現物件導向程式語言裡不同類型系統的資料之間的轉換。從效果上說,它其實是建立了一個可在程式語言裡使用的「虛擬物件資料庫」。如今已有很多免費和付費的ORM產品,而有些程式設計師更傾向於建立自己的ORM工具。
物件導向是從軟體工程基本原則(如耦合、聚合、封裝)的基礎上發展起來的,而關聯式資料庫則是從數學理論發展而來的,兩套理論存在顯著的區別。為了解決這個不匹配的現象,物件關聯對映技術應運而生。
簡單的說:ORM相當於中繼資料。具體到產品上,例如下邊的ADO.NET Entity Framework。DLINQ中實體類的屬性[Table]就算是一種中繼資料。
物件關聯對映成功運用在不同的物件導向持久層產品中,如:TorqueOJBHibernateTopLinkCastor JDOTJDOActive RecordNHibernateADO.NET Entity Framework 等。
-- wikipedia
簡單來說, ORM 就是利用物件導向將資料庫連線過程與操作封裝成使用者容易閱讀的形式。
封裝 Database.ts 的作法其實與 ORM 的概念非常相似,只是筆者不確定這樣的做法是否為 ORM 。
其實 deno_mongo 本身就已經相當易懂再加上 MongoDB 並不像傳統的關聯式資料庫,一般在操作 SQL 時,我們都需要使用 SQL 語法:
1
INSERT INTO customers (C_Id, Name, City, Address, Phone)
2
VALUES (3, '李三', '高雄縣', 'ZZ路300號', '07-12345678');
Copied!
這樣的作法比起 ORM 封裝更不易懂,若沒有適當的防範,更會衍伸出常見的 SQL Injection 的攻擊問題。
因此,我們可以處處看到 ORM 的身影,像是 Laravel 的 eloquent
說了這麼多 ORM 真的這麼好嗎 ? 筆者大概整理了一下 ORM 的優缺點:

優點

  1. 1.
    容易理解
  2. 2.
    安全

缺點

  1. 1.
    效能較差
    因為多了一層物件封裝,所以在執行上,效能會比直接對資料庫操作來的更慢。
  2. 2.
    靈活度較 SQL 語法差
    這點就考驗 ORM 開發者的功力了,因為 SQL 能做的事情非常多,除了一般操作還能將元素排序。

延伸閱讀

同樣的事情在不同人眼中可能會有不同的見解、看法。
在讀完本篇以後,筆者也強烈建議大家去看看以下文章,或許會對型別、變數宣告...等觀念有更深層的看法唷!
Last modified 1yr ago