Question

我正在将代码组织成20-60行模块，通常是模块模式。我想要一个结构良好的面向对象的JavaScript库。

这是最好的方法吗？该代码已经过测试和运作。

我喜欢它，因为程序员可以从库中提取模块并根据需要使用它们，它们是自包含的。

这是工具，消息，效果和文本，全部包含在NS。

中

问题吗

这是组织我的图书馆的好方法（最佳做法）吗？

注意

到目前为止，评论和答案中有0个共识......非常令人沮丧。

外部模块模式

var NS = ( function ( window, undefined ) 
{ 
/* All Modules below here */ 
} )( window );

工具

/**
 *Tools
 *    getTimeLapse - benchmark for adding
 */

var Tool = ( function () 
{
    var Tool = function ( ) 
    {
    };
    Tool.prototype.getTimeLapse = function( numberOfAdds ) 
    {
        var end_time;
        var start_time = new Date().getTime();
        var index = 0;           
        while ( index <= numberOfAdds )
        {
            index++;
        }
        end_time = new Date().getTime();
        return ( end_time - start_time );
    };
    return Tool;
} () );

消息

/**
 *Message
 *    element - holds the element to send the message to via .innerHTML
 *    type - determines the message to send
 */

var Message = ( function () 
{
    var messages = 
    {
        name:         'Please enter a valid name',
        email:        'Please enter a valid email',
        email_s:      'Please enter a valid email.',
        pass:         'Please enter passoword, 6-40 characters',
        url:          'Please enter a valid url',
        title:        'Please enter a valid title',
        tweet:        'Please enter a valid tweet',
        empty:        'Please complete all fields',
        same:         'Please make emails equal',
        taken:        'Sorry, that email is taken',
        validate:     'Please contact <a class="d" href="mailto:foo@foo.com">support</a> to reset your password',
    };
    var Message = function (element) 
    {
        this.element = element;
    };
    Message.prototype.display = function( type ) 
    {
        this.element.innerHTML = messages[ type ];
    };
    return Message;
} () );

效果

/**
 *Effects
 *    element - holds the element to fade
 *    direction - determines which way to fade the element
 *    max_time - length of the fade
 */

var Effects = ( function () 
{
    var Effects = function ( element )
    {
        this.element = element;
    };
    Effects.prototype.fade = function( direction, max_time ) 
    {
        var element = this.element;
        element.elapsed = 0;
        clearTimeout( element.timeout_id );
        function next()
        {
            element.elapsed += 10;
            if ( direction === 'up' )
            {
                element.style.opacity = element.elapsed / max_time;
            }
            else if ( direction === 'down' )
            {
                element.style.opacity = ( max_time - element.elapsed ) / max_time;
            }
            if ( element.elapsed <= max_time ) 
            {
                element.timeout_id = setTimeout( next, 10 );
            }
        }
        next();
    };
    return Effects;
} () );

文字

/**
 *Text
 *    form_elment - holds text to check
 */

var Text = ( function () 
{
    var Text = function ( form_element )
    {
        this.text_array = form_element.elements;
    };
    Text.prototype.patterns = 
    {
        prefix_url:     /^(http:)|(https:)\/\//,
        aml:            /<(.+)_([a-z]){1}>$/,
        url:            /^.{1,2048}$/,
        tweet:          /^.{1,40}$/, 
        title:          /^.{1,32}$/,
        name:           /^.{1,64}$/, 
        email:          /^.{1,64}@.{1,255}$/,
        pass:           /^.{6,20}$/
    };
    Text.prototype.checkPattern = function( type ) 
    {
        return this.patterns[ type ].exec( this.text_array[type].value );
    };
    Text.prototype.checkUrl = function( type ) 
    {
        return this.patterns[ type ].exec( this.text_array.url.value );
    };
    Text.prototype.checkSameEmail = function() 
    {
        return ( ( this.text_array.email.value ) === ( this.text_array.email1.value ) );
    };
    Text.prototype.checkEmpty = function() 
    {
        for ( var index = 0; index < this.text_array.length; ++index ) 
        {
            if ( this.text_array[ index ].value === '') 
            { 
                return 0; 
            }
        }
        return 1;
    };
    return Text;
} () );

Answer 1

我建议改变以使代码更清洁并减少其占用空间的一件事是立即设置原型属性，这样就不用做了

Object.prototype.method1 = function(){};
Object.prototype.method2 = function(){};

你做

Object.prototype = {
    method1: function(){},
    method2: function(){}
};

如果您需要保留建议的构造函数引用，则应该在之后重新分配构造函数。 See this answer for more details

Answer 2

我个人更喜欢使用像ncore

这样的模块化代码组织库

这鼓励您将代码编写为一组模块（每个文件一个模块），然后使用依赖注入和引导将它们连接在一起。

代码稍微可移植，因为模块本身就是对象，但如果不使用ncore，优势就会丢失。

leaderboard app显示了OO代码组织的详细示例

Answer 3

一些建议......首先是创建一个名称空间对象作为库的范围... jQuery使用“jQuery”和“$”，下划线使用“_”。我倾向于使用“CompanyName.SiteName”

if (typeof CompanyName == "undefined") var CompanyName = {};
CompanyName.SiteName = CompanyName.SiteName || {};

第一行显式检查undefined，因为你会在很多浏览器中使用SiteName属性上的方法获取根变量的错误。

从那里开始，我会进行一些调整......当你在线调用一个匿名函数时，最好将整个调用包含在parens中。

CompanyName.SiteName.ModuleName = (function(w){
    ...
    return moduleImplementation;
}(window || this)); //CompanyName.SiteName.ModuleName

这可以通过让parens包裹整个，以及在模块声明的末尾发表评论来避免混淆。

根据上面的评论，您可能希望将原型声明作为更单一的声明。我建议不要这样做，因为较长的模块会使可读性成为一个问题。

myModule.prototype = {
    "method1": function(){
    }
    ...
    "methodN": function(){
       //by the time you get here, you may not see the top, and where you are nested in
    }
};

//with the dot-notation, or hash notation
myModule.prototype.methodN = ...
myModule.prototype["methodN"] = ...
//you can see where you are binding to at that function

您可能还想查看RequireJS和AMD

还有处理更简单对象和使用功能绑定器的概念。将库作为一组函数（类似于C导出）处理，这些函数被传递并使用更简单的对象/类型。这实际上取决于您的需求/用途以及您的需求和用途的具体情况。

您可能还想查看KnockoutJS，Underscore和Backbone等javascript库。

JavaScript组织|模块模式w /模块

3 个答案: