Встраиваемые виджеты с использованием jQuery и ASP.NET MVC - PullRequest
3 голосов
/ 21 февраля 2010

Мне нужен совет для наилучшего подхода к разработке встраиваемых виджетов, который пользователи моего сайта могли бы использовать для показа нашего контента на своем сайте.

Допустим, у нас есть некоторый контент, использующий jQuery Плагин будет отображаться, и мы хотим предоставить нашим клиентам простой способ встраивать его в свои веб-сайты.

Одним из вариантов может быть использование IFrame, но, как мы знаем, это довольно агрессивно и имеетнекоторые проблемы.Мне бы тоже хотелось узнать ваше мнение по этому поводу.

Другой подход мог бы дать такой код, чтобы показать элемент № 23:

<DIV id="mysitewidget23"><script src="http://example.com/scripts/wdg.js?id=23" /></DIV>

И как-то (помощь нужна здесь...) создание серверного сценария wdg.js для внедрения содержимого, jQuery, необходимых плагинов в DIV.

Это выглядит более многообещающе, поскольку пользователь может в определенной степени настроить стильDIV, и не требуется IFRAME.Но какой лучший и более эффективный способ сделать это в ASP.NET MVC?

Конечно, существует множество других подходов для достижения того, что нам нужно.

1 Ответ

12 голосов
/ 21 февраля 2010

JSONP - это один из способов сделать это. Вы начинаете с написания пользовательского ActionResult , который будет возвращать JSONP вместо JSON, что позволит вам обойти междоменное ограничение Ajax :

public class JsonpResult : JsonResult
{
    public override void ExecuteResult(ControllerContext context)
    {
        var response = context.HttpContext.Response;

        if (!string.IsNullOrEmpty(ContentType))
        {
            response.ContentType = ContentType;
        }
        else
        {
            response.ContentType = "application/json";
        }

        if (ContentEncoding != null)
        {
            response.ContentEncoding = ContentEncoding;
        }

        if (Data != null)
        {
            var request = context.HttpContext.Request;
            var serializer = new JavaScriptSerializer();
            if (null != request.Params["jsoncallback"])
            {
                response.Write(string.Format("{0}({1})",
                    request.Params["jsoncallback"],
                    serializer.Serialize(Data)));
            }
            else
            {
                response.Write(serializer.Serialize(Data));
            }
        }
    }
}

Тогда вы могли бы написать действие контроллера, которое возвращает JSONP:

public ActionResult SomeAction()
{
    return new JsonpResult
    {
        Data = new { Widget = "some partial html for the widget" }
    };
}

И, наконец, люди могут вызывать это действие на своих сайтах с помощью jQuery:

$.getJSON('http://www.yoursite.com/controller/someaction?jsoncallback=?',
    function(json)
    {
        $('#someContainer').html(json.Widget);
    }
);

Если пользователи не хотят включать jQuery на свой сайт, вы можете написать на своем сайте код JavaScript, который будет включать jQuery и выполнить предыдущий вызов getJSON, так что людям нужно будет только включить один файл JavaScript с сайта как в вашем примере.


UPDATE:

Как указано в разделе комментариев, приведен пример, иллюстрирующий, как динамически загружать jQuery из вашего скрипта. Просто вставьте в ваш файл JavaScript следующее:

var jQueryScriptOutputted = false;
function initJQuery() {
    if (typeof(jQuery) == 'undefined') {
        if (!jQueryScriptOutputted) {
            jQueryScriptOutputted = true;
            document.write("<scr" + "ipt type=\"text/javascript\" src=\"http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js\"></scr" + "ipt>");
        }
        setTimeout("initJQuery()", 50);
    } else {
        $(function() {
            $.getJSON('http://www.yoursite.com/controller/someaction?jsoncallback=?',
                function(json) {
                    // Of course someContainer might not exist
                    // so you should create it before trying to set
                    // its content
                    $('#someContainer').html(json.Widget);
                }
            );
        });
    }
}
initJQuery();
...