Membina Microblog Menggunakan Node.js, Git dan Markdown

Bina microblog berdasarkan node.js, git dan markdown

Artikel ini meneroka cara membina microblog menggunakan node.js, git, dan beberapa kebergantungan. Aplikasi ini direka untuk menyampaikan kandungan statik dari fail yang dikemukakan kepada repositori. Anda akan belajar bagaimana untuk membina dan menguji permohonan anda dan mendapatkan wawasan tentang proses penyampaian penyelesaian anda. Akhirnya, anda akan mempunyai aplikasi blog yang minimalis dan runnable yang boleh anda bina.

Mata Utama:

node.js menyediakan set API yang seimbang yang sesuai untuk membina platform mikroblog yang tidak memerlukan kerumitan yang tidak perlu.
Git digunakan untuk menyimpan catatan blog sebagai dokumen teks versi tanpa menggunakan pangkalan data tradisional.
Markdown digunakan untuk pemformatan pos blog, yang membolehkan kandungan ringan dan boleh dipertingkatkan secara beransur -ansur.
roast.it digunakan untuk ujian unit kerana ia mudah dan tidak mempunyai kebergantungan, membolehkan maklum balas cepat dan keyakinan pemaju yang dipertingkatkan.
Senibina Microblog direka bentuk di sekitar kesederhanaan, dengan penghalaan dan kebergantungan minimum untuk menyediakan kandungan blog, memastikan prestasi cepat.
Aplikasi ini menggunakan parser markdown adat dan fungsi templat mudah untuk menukar markdown ke HTML, memastikan bahawa blog itu ringan dan responsif.

Komponen utama microblogs

untuk membina blog yang hebat, pertama sekali, anda memerlukan beberapa komponen:

perpustakaan untuk menghantar mesej http
repositori untuk menyimpan catatan blog
pelari ujian unit atau perpustakaan
Parser Markdown

Untuk menghantar mesej HTTP, saya memilih Node.js kerana ia menyediakan semua yang anda perlukan untuk menghantar mesej hiperteks dari pelayan. Kedua -dua modul kepentingan tertentu adalah

dan http. Modul fs akan membuat pelayan HTTP nod. Modul http akan membaca fail. Node mempunyai perpustakaan untuk membina microblogs menggunakan HTTP. fs

Untuk menyimpan repositori pos blog, saya akan memilih git dan bukan pangkalan data berfungsi sepenuhnya. Alasannya ialah Git itu sendiri adalah repositori dokumen teks yang dikawal oleh versi. Ini adalah semua yang saya perlukan untuk menyimpan data pos blog. Menghilangkan menambah pangkalan data sebagai kebergantungan menghalang saya daripada menulis kod untuk banyak masalah.

Saya memilih untuk menyimpan catatan blog dalam format markdown dan menghuraikannya menggunakan

. Jika saya memutuskan untuk melakukan ini kemudian, ini akan membolehkan saya bebas untuk secara beransur -ansur meningkatkan kandungan asal. Markdown adalah alternatif ringan yang baik untuk HTML biasa. marked

Untuk ujian unit, saya memilih Runner Roast.it yang sangat baik. Saya memilih alternatif ini kerana ia tidak mempunyai kebergantungan dan ia memenuhi keperluan ujian unit saya. Anda boleh memilih pelari ujian lain seperti pita, tetapi ia mempunyai kira -kira lapan kebergantungan. Sebab saya suka panggang. Ia adalah bahawa ia tidak mempunyai kebergantungan.

Dengan senarai komponen ini, saya mempunyai semua kebergantungan yang saya perlukan untuk membina microblog.

Memilih kebergantungan tidak mudah. Saya fikir kunci adalah bahawa apa -apa di luar skop masalah semasa boleh menjadi kebergantungan. Sebagai contoh, saya tidak membina pelari ujian atau repositori data, jadi saya menambahnya ke senarai. Tiada kebergantungan yang diberikan dapat menelan penyelesaian dan merampas kod. Oleh itu, masuk akal untuk memilih hanya komponen ringan.

Artikel ini mengandaikan bahawa anda sudah biasa dengan Node, NPM, dan Git, serta pelbagai kaedah ujian. Saya tidak melalui setiap langkah membina langkah mikroblog demi langkah, tetapi fokus pada bidang tertentu kod. Jika anda ingin mengikuti tindakan di rumah dan kod telah dimuat naik ke GitHub, anda boleh mencuba setiap coretan kod.

ujian

Ujian memberi anda keyakinan terhadap kod anda dan menguatkan gelung maklum balas. Gelung maklum balas dalam pengaturcaraan merujuk kepada masa yang diperlukan antara menulis kod baru dan menjalankannya. Dalam mana -mana penyelesaian web, ini bermakna melangkau banyak lapisan untuk mendapatkan sebarang maklum balas. Sebagai contoh, pelayar, pelayan web, dan juga pangkalan data. Apabila kerumitan meningkat, ini bermakna bahawa ia mengambil masa beberapa minit atau bahkan satu jam untuk mendapatkan maklum balas. Menggunakan ujian unit, kami dapat mengurangkan lapisan ini dan mendapatkan maklum balas yang cepat. Ini memberi tumpuan kepada isu semasa.

Saya suka memulakan sebarang penyelesaian dengan menulis ujian unit cepat. Ini membuat saya mula menulis ujian untuk sebarang kod baru. Inilah cara anda mula berjalan menggunakan panggang.it.

tambah ke fail package.json:

"scripts": {
  "test": "node test/test.js"
},
"devDependencies": {
  "roast.it": "1.0.4"
}

Fail adalah di mana anda memperkenalkan semua ujian unit dan menjalankannya. Sebagai contoh, anda boleh melakukan perkara berikut: test.js

var roast = require('roast.it');

roast.it('Is array empty', function isArrayEmpty() {
  var mock = [];

  return mock.length === 0;
});

roast.run();
roast.exit();

Untuk menjalankan ujian, laksanakan

. Untuk keseronokan saya, saya tidak perlu bekerja keras untuk menguji kod baru. Inilah ujian yang mengenai: Pengaturcara gembira mendapat keyakinan dan memberi tumpuan kepada penyelesaian. npm install && npm test

Skeleton

Microblog akan menggunakan nod untuk bertindak balas terhadap permintaan klien. Cara yang berkesan adalah melalui API nod

. Ini dapat dilihat dalam petikan berikut dalam http.CreateServer(): app.js

/* app.js */
var http = require('http');
var port = process.env.port || 1337;

var app = http.createServer(function requestListener(req, res) {
  res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8'});
  res.end('A simple micro blog website with no frills nor nonsense.');
});

app.listen(port);

console.log('Listening on http://localhost:' + port);

Jalankan skrip ini melalui skrip NPM dalam

: package.json

"scripts": {
  "start": "node app.js"
}

Sekarang,

menjadi laluan lalai dan mengembalikan mesej kepada pelanggan. Idea ini adalah untuk menambah lebih banyak laluan untuk mengembalikan respons lain, seperti bertindak balas dengan kandungan pos blog. http://localhost:1337/

Struktur folder

Untuk membina struktur aplikasi, saya memutuskan untuk menggunakan bahagian utama berikut:

Saya akan menggunakan folder ini untuk mengatur kod. Berikut adalah gambaran keseluruhan tujuan setiap folder:

: Simpan catatan blog asal dalam format markdown tulen
• blog
: modul yang boleh diguna semula untuk membina mesej tindak balas kepada pelanggan
• message
: Laluan selain Laluan Lalai
• route
: di mana untuk menulis ujian unit
• test
: di mana untuk meletakkan templat html
• view
lebih banyak penghalaan dan ujian

Untuk kes penggunaan pertama, saya akan memperkenalkan laluan lain ke pos blog. Saya memilih untuk memasukkannya ke dalam komponen yang boleh diuji yang dipanggil BlogRoute. Apa yang saya suka ialah anda boleh menyuntik kebergantungan ke dalamnya. Pemisahan kebimbangan antara unit dan kebergantungan mereka menjadikan ujian unit mungkin. Setiap pergantungan mendapat mengejek dalam ujian terpencil. Ini membolehkan anda menulis ujian tidak berubah, berulang, dan cepat.

Contohnya, pembina kelihatan seperti ini:

"scripts": {
  "test": "node test/test.js"
},
"devDependencies": {
  "roast.it": "1.0.4"
}

ujian unit yang berkesan ialah:

var roast = require('roast.it');

roast.it('Is array empty', function isArrayEmpty() {
  var mock = [];

  return mock.length === 0;
});

roast.run();
roast.exit();

Pada masa ini,

mengharapkan objek BlogRoute yang berasal dari API Node. Untuk mendapatkan ujian yang diluluskan, lakukan perkara berikut: req

/* app.js */
var http = require('http');
var port = process.env.port || 1337;

var app = http.createServer(function requestListener(req, res) {
  res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8'});
  res.end('A simple micro blog website with no frills nor nonsense.');
});

app.listen(port);

console.log('Listening on http://localhost:' + port);

Dengan ini kita boleh menyambungkannya ke saluran paip permintaan. Anda boleh melakukan perkara berikut dalam

: app.js

"scripts": {
  "start": "node app.js"
}

Kelebihan ujian adalah bahawa saya tidak perlu bimbang tentang butiran pelaksanaan terlebih dahulu. Saya akan menentukan

tidak lama lagi. Objek message dan res adalah dari API nod req. http.createServer()

repositori

Masalah seterusnya yang akan diselesaikan adalah membaca data pos blog asal dalam

. Node menyediakan modul BlogRoute.route() yang boleh anda gunakan untuk membaca dari sistem fail. fs

Contoh:

/* route/blogRoute.js */
var BlogRoute = function BlogRoute(context) {
  this.req = context.req;
};

Coretan kod ini terletak di

. Di tengah -tengah penyelesaian, anda membaca fail teks di repositori. Sila ambil perhatian bahawa message/readTextFile.js adalah operasi tak segerak. Itulah sebabnya ia memerlukan panggilan balik fs.readFile() dan memanggilnya dengan data fail. Penyelesaian asynchronous ini menggunakan panggilan balik mudah. fn

Ini menyediakan keperluan untuk fail IO. Apa yang saya suka ialah bahawa ia hanya menyelesaikan satu masalah. Oleh kerana ini adalah isu silang domain, seperti membaca fail, tidak perlu melakukan ujian unit. Ujian unit hanya perlu menguji pengasingan kod anda sendiri, bukan kod orang lain.

Dalam teori, anda boleh mensimulasikan sistem fail dalam ingatan dan menulis ujian unit dengan cara ini, tetapi penyelesaiannya akan mula membocorkan kebimbangan di mana -mana dan berubah menjadi kekeliruan.

Isu-isu silang domain seperti membaca fail berada di luar skop kod. Sebagai contoh, membaca fail bergantung kepada subsistem yang anda tidak dapat mengawal secara langsung. Ini menjadikan ujian rapuh dan meningkatkan masa dan kerumitan gelung maklum balas. Ini adalah masalah yang mesti dipisahkan dari penyelesaian anda.

Parser Markdown

Masalah seterusnya adalah untuk menukar data markdown asal dari repositori ke HTML. Proses ini dibahagikan kepada dua langkah:

Dapatkan templat html dari
• folder view
Purse markdown ke html dan isi templat

Dalam pengaturcaraan bunyi, idea itu adalah untuk memecahkan masalah besar ke bahagian-bahagian kecil, mudah untuk dikendalikan. Mari selesaikan soalan pertama: Bagaimana untuk mendapatkan templat HTML berdasarkan apa yang saya ada

? BlogRoute

satu kaedah mungkin:

/* test/blogRouteTest.js */
roast.it('Is valid blog route', function isValidBlogRoute() {
  var req = {
    method: 'GET',
    url: 'http://localhost/blog/a-simple-test'
  };

  var route = new BlogRoute({ req: req });

  return route.isValidRoute();
});

ingat bahawa ini akan menggantikan panggilan balik maya yang digunakan dalam bahagian sebelumnya, yang dipanggil

. dummyTest

Untuk menggantikan panggilan balik dummyTest, lakukan yang berikut:

"scripts": {
  "test": "node test/test.js"
},
"devDependencies": {
  "roast.it": "1.0.4"
}

(kandungan berikutnya ditinggalkan kerana batasan ruang, sila tambahkan sendiri seperti yang diperlukan)

Atas ialah kandungan terperinci Membina Microblog Menggunakan Node.js, Git dan Markdown. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!