אינטרנט ישראל
  • ראשי
  • אודות רן בר-זיק ואינטרנט ישראל
  • ערוץ טלגרם
  • מסטודון
  • התחברו אלי בטוויטר
  • התחברו אלי בלינקדאין
  • ספר ג'אווהסקריפט
  • ראשי
  • אודות רן בר-זיק ואינטרנט ישראל
  • ערוץ טלגרם
  • מסטודון
  • התחברו אלי בטוויטר
  • התחברו אלי בלינקדאין
  • ספר ג'אווהסקריפט
ראשי » מדריכים » Node.js » מדריך Node.js: לכתוב את המודול שלכם

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

רן בר-זיק ינואר 18, 2015 7:07 am תגובה אחת

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

כדאי תמיד להשאר מעודכנים! אם יש לכם טלגרם, בדקו את ערוץ הטלגרם של האתר שבו אני מעדכן על פוסטים חדשים 🙂 אם אתם רוצים ללמוד תכנות באופן מקיף ומסודר, הצטרפו לאלפי הלומדים בפרויקט "ללמוד ג'אווהסקריפט בעברית" שמלמד לתכנת בג'אווהסקריפט, ב-Node.js ובריאקט וגם מלמד על תרומה לקוד פתוח. גם ספרים דיגיטליים וגם ספרים מודפסים. בשיתוף הקריה האקדמית אונו ובתמיכת חברות מובילות כגון Wix, Outbrain, Elementor, Iron Source, Chegg, Really Good ועוד.

אוהבים את מדריך Node.js? רוצים לדעת עוד?

ספר מקיף על Node.js, בעברית, שנכתב על ידי רן בר-זיק וכולל תרגילים רבים ומידע מקיף - גם על מודולים אסינכרוניים וגם על CLI וסטרימים ומידע רב יותר על Node.js ניתן להורדה ממש פה.
כדאי תמיד להשאר מעודכנים! אם יש לכם טלגרם, בדקו את ערוץ הטלגרם של האתר שבו אני מעדכן על פוסטים חדשים 🙂 אם אתם רוצים ללמוד תכנות באופן מקיף ומסודר, הצטרפו לאלפי הלומדים בפרויקט "ללמוד ג'אווהסקריפט בעברית" שמלמד לתכנת בג'אווהסקריפט, ב-Node.js ובריאקט וגם מלמד על תרומה לקוד פתוח. גם ספרים דיגיטליים וגם ספרים מודפסים. בשיתוף הקריה האקדמית אונו ובתמיכת חברות מובילות כגון Wix, Outbrain, Elementor, Iron Source, Chegg, Really Good ועוד.

במאמר הקודם במדריך למדנו על איך לייצר סביבת פיתוח אמיתית הכוללת דיבאגינג והרצה של הקוד ישירות מה-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), גיל פינק ומתכנתים מעולים נוספים. 

כדאי תמיד להשאר מעודכנים! אם יש לכם טלגרם, בדקו את ערוץ הטלגרם של האתר שבו אני מעדכן על פוסטים חדשים 🙂 אם אתם רוצים ללמוד תכנות באופן מקיף ומסודר, הצטרפו לאלפי הלומדים בפרויקט "ללמוד ג'אווהסקריפט בעברית" שמלמד לתכנת בג'אווהסקריפט, ב-Node.js ובריאקט וגם מלמד על תרומה לקוד פתוח. גם ספרים דיגיטליים וגם ספרים מודפסים. בשיתוף הקריה האקדמית אונו ובתמיכת חברות מובילות כגון Wix, Outbrain, Elementor, Iron Source, Chegg, Really Good ועוד.
כדאי תמיד להשאר מעודכנים! אם יש לכם טלגרם, בדקו את ערוץ הטלגרם של האתר שבו אני מעדכן על פוסטים חדשים 🙂 אם אתם רוצים ללמוד תכנות באופן מקיף ומסודר, הצטרפו לאלפי הלומדים בפרויקט "ללמוד ג'אווהסקריפט בעברית" שמלמד לתכנת בג'אווהסקריפט, ב-Node.js ובריאקט וגם מלמד על תרומה לקוד פתוח. גם ספרים דיגיטליים וגם ספרים מודפסים. בשיתוף הקריה האקדמית אונו ובתמיכת חברות מובילות כגון Wix, Outbrain, Elementor, Iron Source, Chegg, Really Good ועוד.

אוהבים את מדריך Node.js? רוצים לדעת עוד?

ספר מקיף על Node.js, בעברית, שנכתב על ידי רן בר-זיק וכולל תרגילים רבים ומידע מקיף - גם על מודולים אסינכרוניים וגם על CLI וסטרימים ומידע רב יותר על Node.js ניתן להורדה ממש פה.
למאמר הקודם בסדרת המדריכים על Node.jsמדריך Node.js: דיבוג עם IDE
למאמר הבא בסדרת המדריכים על Node.jsמדריך Node.js: בדיקות אוטומטיות עם Mocha
לכל המאמרים במדריך
node.js

תגובה אחת

  1. אור הגב מאי 13, 2020 בשעה 11:19 pm

    האם לא עדיף להשתמש בclass מאשר myModule.prototype.
    אומנם שימוש ב prototype. יתמוך גם בדפדפנים ישנים אבל לדעתי 90% כבר תומכים אז למה לא, האם יש סיבה נוספת ? תודה

השארת תגובה

ביטול

ללמוד ג'אווהסקריפט בעברית

ללמוד לתכנת ג'אווהסקריפט בעברית שגייס יותר משלוש מאות אלף שקל ולמעלה מ-2000 תומכים - בואו ללמוד עכשיו איך לתכנת.

רשימת הנושאים
  • מדריכים
    • ריאקט
    • טייפסקריפט
    • ECMAScript 6
    • ES20XX
    • Node.js
    • Express
    • רספברי פיי
    • Babel
    • docker
    • MongoDB
    • Git
    • לימוד MySQL
    • SASS
    • jQuery
    • CSS3
    • HTML 5
    • SVN
    • LESS
  • פיתוח אינטרנט
    • פתרונות ומאמרים על פיתוח אינטרנט
    • jQuery Scripts
    • jQuery למתקדמים
    • יסודות בתכנות
    • נגישות אינטרנט
  • חדשות אינטרנט
  • מידע כללי על אינטרנט
    • רשת האינטרנט
    • בניית אתרי אינטרנט
  • rss logo

    לכל המאמרים

    לכל המאמרים שפורסמו באינטרנט ישראל משנת 2008 ועד עכשיו.
  • rss logo

    RSS Feed

    משתמשים בקורא RSS? אם כן, עקבו אחרי אינטרנט ישראל באמצעות פיד ה-RSS!
    מה זה RSS?
  • Twitter logo

    עקבו אחרי בטוויטר

    בחשבון הטוויטר שלי אני מפרסם עדכונים מהירים על חדשות בתחום התכנות והיזמות, התרעות על מצבי חירום ורכילות בוערת על תחום הווב.
    מה זה טוויטר?
  • facebook like image

    ערוץ הטלגרם של אינטרנט ישראל

    בערוץ הטלגרם של אינטרנט ישראל אני מפרסם את הפוסטים של באתר וכן עדכונים טכנולוגיים נוספים.
    מה זה טלגרם?
  • github logo

    הפרויקטים שלי בגיטהאב

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

כל הזכויות שמורות לרן בר-זיק ולאינטרנט ישראל | מדיניות הפרטיות של אתר אינטרנט ישראל | אתר אינטרנט ישראל נגיש לפי תקן WCAG 2.0 AA | הצהרת הנגישות של האתר | אבטחת מידע ודיווח על בעיית אבטחת מידע

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