基于MVC+EasyUI的Web開發(fā)框架經(jīng)驗總結(jié)（2）- 使用EasyUI的樹控件構(gòu)建Web界面

最近花了不少時間在重構(gòu)和進(jìn)一步提煉我的Web開發(fā)框架上，力求在用戶體驗和界面設(shè)計方面，和Winform開發(fā)框架保持一致，而在Web上，我主要采用EasyUI的前端界面處理技術(shù)，走M(jìn)VC的技術(shù)路線，在重構(gòu)完善過程中，很多細(xì)節(jié)花費不少時間進(jìn)行研究和提煉，一步步走過來，也0積累了不少經(jīng)驗，本系列將主要介紹我在進(jìn)一步完善我的Web框架基礎(chǔ)上積累的經(jīng)驗進(jìn)行分享，本隨筆主要介紹使用EasyUI的樹控件構(gòu)建Web界面的相關(guān)經(jīng)驗。
在很多界面設(shè)計上，我們可能都需要引入樹列表控件，這個控件可以用zTree來實現(xiàn)，也可以用EasyUI的內(nèi)置樹控件進(jìn)行展示，由于歷史原因，我原來傾向于使用zTree，最新把它全部修改為EasyUI的樹控件，并進(jìn)行了完善優(yōu)化，發(fā)現(xiàn)代碼更加簡潔明快，非常不錯。

1、在界面上使用EasyUI的樹控件

一般情況下，使用EasyUI的樹控件，代碼很簡單，腳本代碼如下所示，主要就是通過調(diào)用url來獲得Json數(shù)據(jù)，然后就可以顯示了，通過onClick就可以響應(yīng)用戶單擊節(jié)點的操作，每個節(jié)點有id, text, iconCls, checked,state,children等屬性。
1）樹控件的Json數(shù)據(jù)綁定

$('#treeDept').tree({
    url: '/User/GetMyDeptTreeJson?userId=@Session["UserId"]',
    onClick: function (node) {
        loadData(node.id);
    }
});

2）樹控件的折疊和展開
樹控件的展開和折疊，可以通過定義兩個通用的腳本進(jìn)行處理，如下所示。

function expandAll(treeName) {
    var node = $('#' + treeName).tree('getSelected');
    if (node) {
        $('#' + treeName).tree('expandAll', node.target);
    }
    else {
        $('#' + treeName).tree('expandAll');
    }
}
function collapseAll(treeName) {
    var node = $('#' + treeName).tree('getSelected');
    if (node) {
        $('#' + treeName).tree('collapseAll', node.target);
    }
    else {
        $('#' + treeName).tree('collapseAll');
    }
}

然后，在頁面加載完畢后，綁定指定的按鈕控件就可以了嗎，如下代碼所示。

//初始化對象
$(document).ready(function () {
    //初始化機(jī)構(gòu)分類
    initOUCategorys();

    //機(jī)構(gòu)基礎(chǔ)信息
    initDeptTreeview();
    $("#deptExpand").bind("click", function () {
        expandAll("treeDept");
    });
    $("#deptCollapse").bind("click", function () {
        collapseAll("treeDept");
    });                       

    $("#loading").center(); //loading的圖片顯示居中
});

3）樹控件的復(fù)選框顯示

樹控件默認(rèn)是沒有復(fù)選框的，它可以通過屬性checkbox設(shè)置讓它進(jìn)行展示的，如下代碼是我項目里面的代碼。

其中cascadeCheck是否讓樹控件級聯(lián)的，默認(rèn)是級聯(lián)，也就是只要父控件被選中，所有其子控件都會被選中，我們可以設(shè)置它為false，讓它不級聯(lián)，這樣在很多情況下是需要的。

$('#treeFunctionView').tree({
    checkbox: true,
    cascadeCheck: false,
    url: '/Function/GetRoleFunctionByUser?userId=@Session["UserId"]',
    onClick: function (node) {
        //
    }
});

4）樹控件的全選和全不選擇

這個全部不選的特性，我找了很多文章，都沒有找到，其實后來才發(fā)現(xiàn)，我們對樹的節(jié)點理解有偏差，認(rèn)識到后，實現(xiàn)起來也很容易。

如取消全部節(jié)點的選中狀態(tài)，代碼如下所示。它的方法getChecked是返回所有的節(jié)點，而不是一個節(jié)點。它們把全部選中的節(jié)點放到一個結(jié)合里面，不像Winform里面，樹節(jié)點需要遞歸查詢，這里只需要一個for循環(huán)就可以展開了，我這里把所有勾選的節(jié)點，設(shè)置為非勾選狀態(tài)就可以實現(xiàn)取消全部樹節(jié)點勾選狀態(tài)了。

function unCheckTree(tree) {
    var nodes = $('#' + tree).tree('getChecked');
    if (nodes) {
        for (var i = 0; i < nodes.length; i++) {
            $('#' + tree).tree('uncheck', nodes[i].target);
        }
    }
}

我們知道，很多樹控件，為了方便操作，都提供了一個全選或者全部不選的操作，這個在EasyUI的樹控件里面，也是很容易實現(xiàn)的。這里的getChildren和上面的意思類似，也是返回所有的子節(jié)點，不需要在進(jìn)行遞歸，用一個for循環(huán)就可以遍歷全部節(jié)點和其下面的多級子節(jié)點了。也就是說，它是一個二維的數(shù)據(jù)，不用遞歸查詢。

function checkAllTree(tree, checked) {
    var children = $('#' + tree).tree('getChildren');
    for (var i = 0; i < children.length; i++) {
        if (checked) {
            $('#' + tree).tree('check', children[i].target);
        } else {
            $('#' + tree).tree('uncheck', children[i].target);
        }
    }
}

5）下拉列表的樹控件初始化
除了普通的樹列表，還有一種比較特殊的樹控件，就是在ComboTree,也就是在下拉列表中集成樹控件，它的操作和普通的樹控件差不多，很多事件屬性都一樣，它的使用代碼如下所示。

//初始化公司
function initCompany() {
    $('#txtCompany_ID').combotree({
        url: '/User/GetMyCompanyTreeJson?userId=@Session["UserId"]',
        valueField: 'id',
        textField: 'text',
        required: true,
        onClick: function (node) {
            //
        }
    });
}

2、樹控件的優(yōu)化

1）普通的Json數(shù)據(jù)生成
前面說了，我們?yōu)榱朔奖?，一般使用Json數(shù)據(jù)和javascript打交道，而EasyUI的樹控件支持很好地的Json鏈接綁定，因此我們只需要在對應(yīng)的控制器里面實現(xiàn)json數(shù)據(jù)的生成即可，如果是一開始想要確定的Json數(shù)據(jù)，一般也是通過手工生成的居多，如下代碼所示。

public ActionResult GetTreeJson()
{
    string folder = "/Content/JqueryEasyUI/themes/icons/customed/" + "organ.png";
    string leaf = "/Content/JqueryEasyUI/themes/icons/customed/" + "organ.png";
    string json = GetTreeJson(-1, folder, leaf);
    json = json.Trim(',');
    return Content(string.Format("[{0}]", json));
}

/// <summary>
/// 遞歸獲取樹形信息
/// </summary>
/// <param name="PID"></param>
/// <returns></returns>
private string GetTreeJson(int PID, string folderIcon, string leafIcon)
{
    string condition = string.Format("PID={0}", PID);
    List<OUInfo> nodeList = BLLFactory<OU>.Instance.Find(condition);
    StringBuilder content = new StringBuilder();
    foreach (OUInfo model in nodeList)
    {
        int ParentID = (model.PID == -1 ? 0 : model.PID);
        //string tempMenu = string.Format("{{ id:{0}, pId:{1}, name:\"{2}\",icon:\"{3}\" }},", model.ID, ParentID, model.Name, imgsrc);
        string subMenu = this.GetTreeJson(model.ID, folderIcon, leafIcon);
        string parentMenu = string.Format("{{ \"id\":{0}, \"pId\":{1}, \"name\":\"{2}\" ", model.ID, ParentID, model.Name);
        if (string.IsNullOrEmpty(subMenu))
        {
            if (!string.IsNullOrEmpty(leafIcon))
            {
                parentMenu += string.Format(",\"icon\":\"{0}\" }},", leafIcon);
            }
            else
            {
                parentMenu += "},";
            }
        }
        else
        {
            if (!string.IsNullOrEmpty(folderIcon))
            {
                parentMenu += string.Format(",\"icon\":\"{0}\" }},", folderIcon);
            }
            else
            {
                parentMenu += "},";
            }
        }

        content.AppendLine(parentMenu.Trim());
        content.AppendLine(subMenu.Trim());
    }

    return content.ToString().Trim();
}

上面的代碼很好實現(xiàn)了根據(jù)數(shù)據(jù)庫結(jié)構(gòu)的關(guān)系，生成Json數(shù)據(jù)，但是感覺部分硬編碼，湊出來的數(shù)據(jù)，始終感覺不太理想，如果我們要簡化，該如何操作呢？

2）簡潔美觀的Json數(shù)據(jù)生成

本小節(jié)繼續(xù)上面的議題，看如何簡化json的生成，因為我們需要很多這樣的json操作，如果采用上面的方法，我感覺很容易出錯，而且也不太美觀。為了解決這個問題，我們可以通過定義一個json數(shù)據(jù)的實體類，用來承載相關(guān)的信息，如下定義所示。

/// <summary>
/// 定義EasyUI樹的相關(guān)數(shù)據(jù)，方便控制器生成Json數(shù)據(jù)進(jìn)行傳遞
/// </summary>
[DataContract]
[Serializable]
public class EasyTreeData
{
    /// <summary>
    /// ID
    /// </summary>
    [DataMember]
    public string id { get; set; }

    /// <summary>
    /// 節(jié)點名稱
    /// </summary>
    [DataMember]
    public string text { get; set; }
    
    /// <summary>
    /// 是否展開
    /// </summary>
    [DataMember]
    public string state  { get; set; }

    /// <summary>
    /// 圖標(biāo)樣式
    /// </summary>
    [DataMember]
    public string iconCls { get; set; }


    /// <summary>
    /// 子節(jié)點集合
    /// </summary>
    [DataMember]
    public List<EasyTreeData> children { get; set; }
    
    /// <summary>
    /// 默認(rèn)構(gòu)造函數(shù)
    /// </summary>
    public EasyTreeData() 
    {
        this.children = new List<EasyTreeData>();
        this.state = "open";
    }

    /// <summary>
    /// 常用構(gòu)造函數(shù)
    /// </summary>
    public EasyTreeData(string id, string text, string iconCls = "", string state = "open")
        : this()
    {
        this.id = id;
        this.text = text;
        this.state = state;
        this.iconCls = iconCls;
    }

    /// <summary>
    /// 常用構(gòu)造函數(shù)
    /// </summary>
    public EasyTreeData(int id, string text, string iconCls = "", string state = "open")
        : this()
    {
        this.id = id.ToString();
        this.text = text;
        this.state = state;
        this.iconCls = iconCls;
    }
}

然后，我們在需要生成Json數(shù)據(jù)的地方，使用這個實體類進(jìn)行承載，然后把它列表生成Json就可以了，很簡單了，呵呵。

/// <summary>
/// 根據(jù)用戶獲取對應(yīng)人員層次的樹Json
/// </summary>
/// <param name="deptId">用戶所在部門</param>
/// <returns></returns>
public ActionResult GetUserTreeJson(int deptId)
{
    List<EasyTreeData> treeList = new List<EasyTreeData>();
    treeList.Insert(0, new EasyTreeData(-1, "無"));

    List<UserInfo> list = BLLFactory<User>.Instance.FindByDept(deptId);
    foreach (UserInfo info in list)
    {
        treeList.Add(new EasyTreeData(info.ID, info.FullName, "icon-user"));
    }

    string json = ToJson(treeList);
    return Content(json);
}

如果需要遞歸的操作，一樣的方式處理就可以了。

/// <summary>
/// 獲取用戶的部門樹結(jié)構(gòu)(分級需要）
/// </summary>
/// <param name="userId">用戶ID</param>
/// <returns></returns>
public ActionResult GetMyDeptTreeJson(int userId)
{
    StringBuilder content = new StringBuilder();
    UserInfo userInfo = BLLFactory<User>.Instance.FindByID(userId);
    if (userInfo != null)
    {
        OUInfo groupInfo = GetMyTopGroup(userInfo);
        if (groupInfo != null)
        {
            List<OUNodeInfo> list = BLLFactory<OU>.Instance.GetTreeByID(groupInfo.ID);

            EasyTreeData treeData = new EasyTreeData(groupInfo.ID, groupInfo.Name, GetIconcls(groupInfo.Category));
            GetTreeDataWithOUNode(list, treeData);

            content.Append(base.ToJson(treeData));
        }
    }
    string json = string.Format("[{0}]", content.ToString().Trim(','));
    return Content(json);
}

上面使用EasyTreeData來承載數(shù)據(jù)，然后構(gòu)建列表，其本身就是一個多層級的樹對象，然后一個ToJson的方法就可以把列表對象完美轉(zhuǎn)換為Jason數(shù)據(jù)了。

這里的ToJson，主要就是調(diào)用JavaScriptSerializer 對象進(jìn)行的操作，如下所示。

/// <summary>
/// 把對象為json字符串
/// </summary>
/// <param name="obj">待序列號對象</param>
/// <returns></returns>
protected string ToJson(object obj)
{
    string jsonData = (new JavaScriptSerializer()).Serialize(obj);
    return jsonData;
}

3、樹控件效果展示

在介紹如何使用它之后，我們來看看我?guī)讉€場景中使用樹控件進(jìn)行的展示效果，方便我們加深上面EasyUI樹控件使用的了解。
1）組織機(jī)構(gòu)列表如下所示：



2）角色樹列表展示


3）功能樹列表展示



4）菜單樹列表展示



5）登陸日志樹列表展示

6）下拉列表樹展示



最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容