jQuery+zTree載入樹形結構選單

阿新 • • 發佈：2021-06-23

由於專案中需要設計樹形選單功能，經過一番搗騰之後，終於給弄出來了，所以便記下來，也算是學習zTree的一個總結吧。

zTree的介紹：

1、zTree 是利用 JQuery 的核心程式碼，實現一套能完成大部分常用功能的 Tree 外掛

2、zTree v3.0 將核心程式碼按照功能進行了分割，不需要的程式碼可以不用載入

3、採用了延遲載入技術，上萬節點輕鬆載入，即使在 IE6 下也能基本做到秒殺

4、相容 IE、FireFox、Chrome、Opera、Safari 等瀏覽器

5、支援 JSON 資料

6、支援靜態和 Ajax 非同步載入節點資料

7、支援任意更換面板 / 自定義圖示（依靠css）

8、支援極其靈活的 checkbox 或 radio 選擇功能

9、提供多種事件響應回撥

10、靈活的編輯（增/刪/改/查）功能，可隨意拖拽節點，還可以多節點拖拽喲

11、在一個頁面內可同時生成多個 Tree 例項

核心的函式和屬性介紹：

核心：zTree(setting, [zTreeNodes])

這個函式接受一個JSON格式的資料物件setting和一個JSON格式的資料物件zTreeNodes，從而建立 Tree。

核心引數：setting

zTree 的引數配置都在這裡完成，簡單的說：樹的樣式、事件、訪問路徑等都在這裡配置

var setting = { 
    showLine: true, 
    checkable: true 
  };

因為引數太多，具體引數詳見zTreeAPI

核心引數：zTreeNodes

zTree 的全部節點資料集合，採用由JSON物件組成的資料結構，簡單的說：這裡使用Json格式儲存了樹的所有資訊

1、zTree官方網站：http://www.ztree.me/v3/main.php#_zTreeInfo

在官網能夠下載到zTree的原始碼、例項和API，其中作者pdf的API寫得非常詳細

關於zTree的節點資料的獲取方式分為靜態（直接定義）的和動態（後臺資料庫載入）的

具體的配置步驟：

第一步 —— 引入相關檔案

<link rel="stylesheet" href="ztree/css/zTreeStyle/zTreeStyle.css" type="text/css">
<script type="text/javascript" src="js/jQuery/jquery-1.9.1.min.js"></script>
<script type="text/javascript" src="ztree/js/jquery.ztree.core-3.5.min.js"></script>
<script type="text/javascript" src="ztree/js/jquery.ztree.excheck-3.5.min.js"></script>

備註：

1、第一個（zTreeStyle.css）是zTree的樣式css檔案，引入了這個，才能呈現出樹形的結構樣式，

2、第二個（jquery-1.9.1.min.js）是jQuery檔案，因為要用到，

3、第三個（jquery.ztree.core-3.5.min.js）則是zTree的核心js檔案，這個是必須的，

4、最後一個（js/jquery.ztree.excheck-3.5.min.js）則是拓展檔案，主要用於單選框和複選框的功能，因為用到了複選框，所以也要要引進來。

第二步 —— 相關配置（具體的詳細配置，請到官網參考詳細API文件）

var zTree;
var setting = {
  view: {
    dblClickExpand: false,//雙擊節點時，是否自動展開父節點的標識
    showLine: true,//是否顯示節點之間的連線
    fontCss:{'color':'black','font-weight':'bold'},//字型樣式函式
    selectedMulti: false //設定是否允許同時選中多個節點
  },
  check:{
    //chkboxType: { "Y": "ps", "N": "ps" },
    chkStyle: "checkbox",//複選框型別
    enable: true //每個節點上是否顯示 CheckBox 
  },
  data: {
    simpleData: {//簡單資料模式
      enable:true,
      idKey: "id",
      pIdKey: "pId",
      rootPId: ""
    }
  },
  callback: {
    beforeClick: function(treeId, treeNode) {
      zTree = $.fn.zTree.getZTreeObj("user_tree");
      if (treeNode.isParent) {
        zTree.expandNode(treeNode);//如果是父節點，則展開該節點
      }else{
        zTree.checkNode(treeNode, !treeNode.checked, true, true);//單擊勾選，再次單擊取消勾選
      }
    }
  }
};

第三步 —— 節點資料載入，呈現樹形結構

1、html頁面，直接放一個ul就可以，資料最終會自動載入到這個ul元素裡面

<body>
  <div class="zTreeDemoBackground left">
    <ul id="user_tree" class="ztree" style="border: 1px solid #617775;overflow-y: scroll;height: 500px;"></ul>
  </div>
</body>

2、js中進行資料的載入

一，靜態方式（直接定義）

var zNodes =[
  { id:1, pId:0, name:"test 1", open:false},
  { id:11, pId:1, name:"test 1-1", open:true},
  { id:111, pId:11, name:"test 1-1-1"},
  { id:112, pId:11, name:"test 1-1-2"},
  { id:12, pId:1, name:"test 1-2", open:true},
         ];
         
$(document).ready(function(){
  $.fn.zTree.init($("#user_tree"), setting, zNodes);
});
function onCheck(e,treeId,treeNode){
  var treeObj=$.fn.zTree.getZTreeObj("user_tree"),
  nodes=treeObj.getCheckedNodes(true),
  v="";
  for(var i=0;i<nodes.length;i++){
    v+=nodes[i].name + ",";
    alert(nodes[i].id); //獲取選中節點的值
  }
}

二、動態方式（從後臺資料庫載入）

/**
 * 頁面初始化
 */
$(document).ready(function(){
  onLoadZTree();
});

/**
 * 載入樹形結構資料
 */
function onLoadZTree(){
  var treeNodes;
  $.ajax({
    async:false,//是否非同步
    cache:false,//是否使用快取
    type:'POST',//請求方式：post
    dataType:'json',//資料傳輸格式：json
    url:$('#ctx').val()+"SendNoticeMsgServlet?action=loadUserTree",//請求的action路徑
    error:function(){
      //請求失敗處理函式
      alert('親，請求失敗！');
    },
    success:function(data){
      //console.log(data);
      //請求成功後處理函式
      treeNodes = data;//把後臺封裝好的簡單Json格式賦給treeNodes
    }
  });
  
  var t = $("#user_tree");
  t = $.fn.zTree.init(t, setting, treeNodes);
}

java後臺載入資料程式碼：

1、定義tree的VO類，這個也可以不用定義，由於我要用到其他操作，方便一些

/**
 * zTree樹形結構物件VO類
 * 
 * @author Administrator
 * 
 */
public class TreeVO {
  private String id;//節點id
  private String pId;//父節點pId I必須大寫
  private String name;//節點名稱
  private String open = "false";//是否展開樹節點，預設不展開

  public String getId() {
    return id;
  }

  public void setId(String id) {
    this.id = id;
  }

  public String getpId() {
    return pId;
  }

  public void setpId(String pId) {
    this.pId = pId;
  }

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public String getOpen() {
    return open;
  }

  public void setOpen(String open) {
    this.open = open;
  }

}

2、查詢資料庫，並且sql的結構欄位也要是id,pId,name,open(可選)這種格式（注意：pId中間的I必須大寫），然後將結果封裝到TreeVO類中。

/**
   * 載入樹形結構資料
   * @param request
   * @param response
   * @throws IOException 
   */
  public void loadUserTree(HttpServletRequest request, HttpServletResponse response) throws IOException{
    WeiXinUserService weixinUserService = new WeiXinUserServiceImpl();
    List<TreeVO> user_tree_list = weixinUserService.getUserTreeList();
    String treeNodesJson = JSONArray.fromObject(user_tree_list).toString();//將list列表轉換成json格式 返回
    
    PrintWriter out = response.getWriter();
    //利用Json外掛將Array轉換成Json格式  
    out.print(treeNodesJson);
    
    //釋放資源
    out.close();
  }