מדריך Node.js: לכתוב את המודול שלכם

הסבר על כתיבת מודול ב-Node.js - כיצד יוצרים את ה-package.js ואת נקודת הכניסה ופרסום ב-NPM
Node.js Logo

במאמר הקודם במדריך למדנו על איך לייצר סביבת פיתוח אמיתית הכוללת דיבאגינג והרצה של הקוד ישירות מה-IDE. הראיתי איך אני מתקין ומדבג עם PHPStorm שאינו שונה מהותית מכל עורך של IntelliJ. אבל אין שום מניעה להתקין סביבה דומה על Sublime, או על NetBeans או כל IDE אחר. כל אחד וההעדפות שלו.

באופן עקרוני, אני לא אלמד כאן דברים שמי שעבר על החלקים הקודמים במדריך ה-Node.js יפול בגללם מהכיסא. באופן עקרוני, מודול הוא בסך הכל קוד שארוז באופן שיהיה קל להשתמש בו. גם אם אתם לא מתכננים לפרסם את המודול שלכם לעולם, אבל יש סיכוי שתשתמשו בו עוד – כדאי לארוז אותו בתור מודול.

יש לא מעט design patterns למודולים, אני לא עובר עליהם כאן (ואני גם לא מכיר את כולם) אלא אתמקד בזה הפשוט יותר שלפי דעתי מתאים לרוב הצרכים בבניית מודול פשוט שלא צריך פריימוורק. איך מתחילים לכתוב? באופן עקרוני, זה עובד ככה: אני יוצר שני קבצים. אחד בתוך תיקית lib. הוא זה שמכיל את המודול שלי. אפשר לקרוא לו למשל my-module.js. בו יש את כל המודול שלנו. הנה, זה נראה כך:


module.exports.myPublicFunction = function (arg1, arg2, ...) {
//my public function
};

function whatever(arg1, arg2, ...) {
//My private function
}

בסך הכל מאוד פשוט. דיברנו על export כשדיברנו על require. כל מה שנכנס לשם יהיה זמין למשתמש.

אם אנו רוצים לספק entry point למשתמש שלנו, אנו ניצור קובץ index.js שבו נעשה מימוש ל-singleton. אני באופן אישי מוצא את זה מאוד נוח. index.js יראה כך:


var module = require('./lib/my-module.js');


function myModule() {
    if (false === (this instanceof myModule)) {
        return new myModule();
    }
}
myModule.prototype.myPublicFunction = function (log_file_position, callback)  {
    module.myPublicFunction(log_file_position, callback);
}


module.exports = new myModule();

על מנת ש:


var whatever = require('my-module');

יעבוד, אנו זקוקים ל- package.json. דיברנו עליו כשדיברנו על deployment ל-heroku. אבל באופן עקרוני מדובר ב-json שמייצרים אותו באופן אוטומטי באמצעות הפקודה:


npm init

שם אנו בוחרים שם למודול שלנו ושם גם אנו בוחרים את ה-entry point שלנו. שהוא index.js. בסופו של דבר, זה אמור להראות ככה:


{
  "name": "my-module",
  "version": "1.0.0",
  "description": "Some module",
  "main": "index.js",
  "dependencies": {
    "socket.io": "~1.1.0"
  },
}

איך בודקים את זה? עושים require ואז מנסים להשתמש במתודות הפומביות שכתבתם. זה הכל.

ואם צריך דוגמה חיה – אפשר להסתכל על המודול שכתבתי. ולנסות להעתיק משם.

כדי להמחיש את העניין בצורה יותר נרחבת – יצרתי סוג של 'בוילרפלייט' ממש ממש בסיסי בגיטהאב שמכיל שלד מינימלי של מודול שפשוט אפשר להעתיק ולהשתמש בו. אני משתץמש ב"בוילרפלייט" הזה בכל מודול בסיסי שאני יוצר.

אם אתם רוצים לפרסם את המודול שכתבתם ב-NPM, על מנת שעוד אנשים יוכלו להוריד ולהשתמש בו, כל מה שצריך זה:

ליצור משתמש ב-npm:


npm set init.author.name "Your Name"
npm set init.author.email "[email protected]"
npm set init.author.url "http://yourblog.com"

npm adduser

ליצור את package.json:


cd /path/to/your-project
npm init

לא לשכוח לוודא שכל ה-dependencies (כלומר המודולים שאתם משתמשים בהם) נמצאים שם עם הגרסאות הנכונות.

ואז כל מה שנותר לעשות זה:


npm publish ./

והמודול יתווסף ל-npm, אנשים אחרים יוכלו להשתמש בו ותוכלו להתקין את המודול שלכם ישירות מ-NPM.

בגדול, זהו. אני ממליץ לכל מי שקרא להתחיל ולכתוב את הקוד שלכם בתור מודול. בסופו של יום אין תחליף לקוד אמיתי שכותבים לבד. המדריך לא ילמד אתכם את זה.

בחלק הבא במדריך נדבר על בדיקות אוטומטיות עם Mocha.

⚠️ תזכורת – המדריכים האלו הם רק טעימה, בספר שלי "ללמוד Node.js בעברית" יש הסברים מלאים ומקיפים על השפה המיועדים ללימוד עצמי. עם תרגילים והסברים. הספר יצא לאור בשיתוף הקריה האקדמית אונו ובתמיכת החברות אלמנטור, ו-Iron source ונערך טכנית על ידי בנג'י גרינבאום (מפתח ליבה של Node.js), גיל פינק ומתכנתים מעולים נוספים. 

פוסטים נוספים שכדאי לקרוא

פתרונות ומאמרים על פיתוח אינטרנט

המנעו מהעלאת source control לשרת פומבי

לא תאמינו כמה אתרים מעלים את ה-source control שלהם לשרת. ככה תמצאו אותם וגם הסבר למה זה רעיון רע.

פתרונות ומאמרים על פיתוח אינטרנט

נגישות טכנית – פודקאסט ומבוא

פרק בפודקאסטעל נגישות בעברית שצולל לכלים האוטומטיים ולפן המאד מאד טכני של הנגישות.

תמונה של הבית הלבן עם מחשוב ענן וטקסט: FEDRAMP
פתרונות ומאמרים על פיתוח אינטרנט

FedRAMP & FIPS מבוא למתחילים

פרק מיוחד, לצד הקלטה של פרק של עושים תוכנה על אחת התקינות החשובות ביותר עבור חברות שסביר להניח שלא הכרתם

ספריות ומודולים

מציאת PII באמצעות למידת מכונה

כך תגנו על משתמשים שלכם שמעלים מידע אישי רגיש כמו תעודות זהות באמצעות שירות אמאזוני.

מיקרו בקרים

בית חכם עם ESPHome ו Home Assistant

הסבר על הום אסיסטנט, מערכת הקוד הפתוח לבית חכם ואיך לחבר אליה מיקרובקרים.

גלילה לראש העמוד