Java實現級聯下拉結構的示例代碼
前言
在開發過程中，會遇到很多的實體需要將查出的數據處理為下拉或者級聯下拉的結構，提供給前端進行展示。
在數據庫查出的結構中，可能是集合<實體類>的結構，也有可能是List<Map>的結構。
在下拉或者級聯下拉的節點數據中，有時候還需要動態的攜帶其他的參數，已便於前端對某些數據的顯示
如區域的級聯下拉樹中，需要攜帶經緯度的區域–在選擇的時候在地圖展示該區域
基於上面的業務場景，構建瞭下面的工具類，不當的地方請大傢多多指教
註：在構建下拉樹的時候，會存在父類id的判斷，可能沒有涵蓋到你們的使用情況，自行修改添加
構建統一返回下拉結構
/**
* Treeselect樹結構實體類
*
* @author gongl
*/
@ApiModel("下拉樹結構")
public class TreeSelect implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 節點ID
*/
@ApiModelProperty("節點id")
private String id;
/**
* 節點名稱
*/
@ApiModelProperty("節點名")
private String label;
/**
* 下拉節點中攜帶數據
*/
@JsonInclude(JsonInclude.Include.NON_EMPTY)
@ApiModelProperty("節點攜帶數據")
private Map<String, Object> dataMap;
/**
* 子節點
*/
@JsonInclude(JsonInclude.Include.NON_EMPTY)
@ApiModelProperty("子節點集合")
private List<TreeSelect> children;
public TreeSelect() {
}
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public String getLabel() {
return label;
}
public void setLabel(String label) {
this.label = label;
}
public List<TreeSelect> getChildren() {
return children;
}
public void setChildren(List<TreeSelect> children) {
this.children = children;
}
public Map<String, Object> getDataMap() {
return dataMap;
}
public void setDataMap(Map<String, Object> dataMap) {
this.dataMap = dataMap;
}
構建集合<對象>轉下拉樹工具類
/**
* 下拉和級聯下拉通用生成工具類
*
* @Author gongl
* @Create 2022-01-12
*/
public class TreeSelectUtils {
private static final Logger log = LoggerFactory.getLogger(TreeSelectUtils.class);
/**
* 默認id名稱
*/
public static final String ID = "id";
/**
* 默認父類id名稱
*/
public static final String PARENT = "parentId";
/**
* 默認label名稱
*/
public static final String LABEL = "name";
/**
* 單層下拉結構
*
* @param collection 目標集合
* @param id 節點編號字段
* @param label 節點名字段
* @param clazz 集合元素類型
* @param args 需要攜帶的參數
* @return 轉換後的下拉結構 TreeSelect
*/
public static <E> List<TreeSelect> singleTree(Collection<E> collection, String id, String label,
Class<?> clazz, String... args) {
try {
if (collection == null || collection.isEmpty()) {
return null;
}
Field idField;
try {
idField = clazz.getDeclaredField(id);
} catch (NoSuchFieldException e1) {
idField = clazz.getSuperclass().getDeclaredField(id);
}
Field labelField;
try {
labelField = clazz.getDeclaredField(label);
} catch (NoSuchFieldException e1) {
labelField = clazz.getSuperclass().getDeclaredField(label);
}
idField.setAccessible(true);
labelField.setAccessible(true);
List<TreeSelect> list = new ArrayList<>();
for (E e : collection) {
TreeSelect select = new TreeSelect();
select.setId(String.valueOf(idField.get(e)));
select.setLabel(String.valueOf(labelField.get(e)));
list.add(select);
dynamicData(select, e, clazz, args);
}
idField.setAccessible(false);
labelField.setAccessible(false);
return list;
} catch (Exception e) {
log.error("單層下拉異常：", e);
e.printStackTrace();
return null;
}
}
/**
* 集合轉樹結構(默認樹結構字段)
*
* @param collection 目標集合
* @param clazz 集合元素類型
* @param args 需要攜帶的參數
* @return 轉換後的樹形結構 TreeSelect
*/
public static <E> List<TreeSelect> toTree(@NotNull Collection<E> collection, @NotNull Class<?> clazz,
String... args) {
return toTree(collection, null, null, null, clazz, args);
}
/**
* 集合轉樹結構(自定義名稱字段)
*
* @param collection 目標集合
* @param label 節點名字段
* @param clazz 集合元素類型
* @param args 需要攜帶的參數
* @return 轉換後的樹形結構 TreeSelect
*/
public static <E> List<TreeSelect> toTree(@NotNull Collection<E> collection, @NotEmpty String label,
@NotNull Class<?> clazz, String... args) {
return toTree(collection, null, null, label, clazz, args);
}
/**
* 集合轉樹結構(默認父類id字段為parentId，其他自定義)
*
* @param collection 目標集合
* @param id 節點編號字段
* @param label 節點名字段
* @param clazz 集合元素類型
* @param args 需要攜帶的參數
* @return 轉換後的樹形結構 TreeSelect
*/
public static <E> List<TreeSelect> toTree(@NotNull Collection<E> collection, @NotEmpty String id, @NotEmpty String label,
@NotNull Class<?> clazz, String... args) {
return toTree(collection, id, null, label, clazz, args);
}
/**
* 集合轉樹結構(自定義樹結構的字段)
*
* @param collection 目標集合
* @param id 節點編號字段
* @param parent 父節點編號字段
* @param label 節點名字段
* @param clazz 集合元素類型
* @param args 需要攜帶的參數
* @return 轉換後的樹形結構 TreeSelect
*/
public static <E> List<TreeSelect> toTree(@NotNull Collection<E> collection, String id, String parent, String label,
@NotNull Class<?> clazz, String... args) {
try {
if (collection == null || collection.isEmpty()) {
return null;
}
//可以默認名稱
if (StringUtils.isEmpty(id)) {
id = ID;
}
if (StringUtils.isEmpty(parent)) {
parent = PARENT;
}
if (StringUtils.isEmpty(label)) {
label = LABEL;
}
//是對象
return collectionObj(collection, id, parent, label, clazz, args);
} catch (Exception e) {
log.error("多層下拉樹異常：", e);
return null;
}
}
/**
* 集合對象的封裝
*/
private static <E> List<TreeSelect> collectionObj(@NotNull Collection<E> collection, String id, String parent, String label,
@NotNull Class<?> clazz, String... args) throws NoSuchFieldException, IllegalAccessException {
// 初始化根節點集合
List<TreeSelect> list = new ArrayList<>();
// 獲取 id 字段, 從當前對象或其父類
Field idField;
try {
idField = clazz.getDeclaredField(id);
} catch (NoSuchFieldException e1) {
idField = clazz.getSuperclass().getDeclaredField(id);
}
// 獲取 parentId 字段, 從當前對象或其父類
Field parentField;
try {
parentField = clazz.getDeclaredField(parent);
} catch (NoSuchFieldException e1) {
parentField = clazz.getSuperclass().getDeclaredField(parent);
}
// 獲取 label 字段, 從當前對象或其父類
Field labelField;
try {
labelField = clazz.getDeclaredField(label);
} catch (NoSuchFieldException e1) {
labelField = clazz.getSuperclass().getDeclaredField(label);
}
idField.setAccessible(true);
parentField.setAccessible(true);
labelField.setAccessible(true);
// 找出所有的根節點
for (E e : collection) {
Object parentId = parentField.get(e);
if (isParentNode(parentId, idField, collection)) {
TreeSelect select = new TreeSelect();
select.setId(String.valueOf(idField.get(e)));
select.setLabel(String.valueOf(labelField.get(e)));
list.add(select);
dynamicData(select, e, clazz, args);
}
}
// 依次添加子節點
for (TreeSelect select : list) {
addChild(select, collection, idField, parentField, labelField, clazz, args);
}
idField.setAccessible(false);
parentField.setAccessible(false);
labelField.setAccessible(false);
return list;
}
/**
* 添加跟隨下拉的字段
*
* @param treeSelect 當前節點
* @param e
* @param clazz
* @param args 需要跟隨的字段
* @throws IllegalAccessException
* @throws NoSuchFieldException
*/
private static <E> void dynamicData(@NotNull TreeSelect treeSelect, @NotNull Object e, @NotNull Class<E> clazz, String... args) throws IllegalAccessException, NoSuchFieldException {
if (args.length > 0) {
Map<String, Object> dataMap = new HashMap<>();
for (String arg : args) {
Field field;
try {
field = clazz.getDeclaredField(arg);
} catch (NoSuchFieldException e1) {
field = clazz.getSuperclass().getDeclaredField(arg);
}
field.setAccessible(true);
dataMap.put(arg, field.get(e));
field.setAccessible(false);
}
treeSelect.setDataMap(dataMap);
}
}
/**
* 為目標節點添加孩子節點
*
* @param node 目標節點
* @param collection 目標集合
* @param idField ID 字段
* @param parentField 父節點字段
* @param labelField 字節點字段
*/
private static <E> void addChild(@NotNull TreeSelect node, @NotNull Collection<E> collection,
@NotNull Field idField, @NotNull Field parentField, @NotNull Field labelField,
@NotNull Class<?> clazz, String... args) throws IllegalAccessException, NoSuchFieldException {
//父節點的id
String id = node.getId();
//子節點集合
List<TreeSelect> children = new ArrayList<>();
for (E e : collection) {
String parentId = String.valueOf(parentField.get(e));
if (id.equals(parentId)) {
// 將當前節點添加到目標節點的孩子節點
TreeSelect treeSelect = new TreeSelect();
treeSelect.setId(String.valueOf(idField.get(e)));
treeSelect.setLabel(String.valueOf(labelField.get(e)));
dynamicData(treeSelect, e, clazz, args);
children.add(treeSelect);
// 遞歸添加子節點
addChild(treeSelect, collection, idField, parentField, labelField, clazz, args);
}
}
node.setChildren(children);
}
/**
* 判斷是否是根節點, 判斷方式為:
* 1、父節點編號為空或為 0, 則認為是根節點
* 2、父節點在集合中不存在父節點
*
* @param parentId 父節點編號
* @return 是否是根節點
*/
private static <E> boolean isParentNode(Object parentId, Field idField, @NotNull Collection<E> collection) throws IllegalAccessException {
if (parentId == null) {
return true;
} else if (parentId instanceof String && (StringUtils.isEmpty(String.valueOf(parentId)) || parentId.equals("0"))) {
return true;
} else if (parentId instanceof Long && Long.valueOf(0).equals(parentId)) {
return true;
} else {
for (E e : collection) {
Object o = idField.get(e);
if (Objects.equals(o, parentId)) {
return false;
}
}
return true;
}
}
}
構建List<Map>轉下拉或下拉樹的工具類
/**
* 下拉和級聯下拉通用生成工具類
*
* @Author gongl
* @Create 2022-01-12
*/
public class MapToTreeSelectUtils {
private static final Logger log = LoggerFactory.getLogger(MapToTreeSelectUtils.class);
/**
* 數據庫默認父類id名稱
*/
public static final String DB_PARENT = "parent_id";
/**
* 集合轉樹結構(自定義樹結構的字段)
*
* @param collection 目標集合
* @param id 節點編號字段
* @param parent 父節點編號字段
* @param label 節點名字段
* @param args 需要攜帶的參數
* @return 轉換後的樹形結構 TreeSelect
*/
public static List<TreeSelect> mapToTree(String id, String parent, String label,
@NotNull List<Map<String, Object>> collection, String... args) {
try {
if (collection == null || collection.isEmpty()) {
return new ArrayList<>();
}
//可以默認名稱
if (StringUtils.isEmpty(id)) {
id = TreeSelectUtils.ID;
}
if (StringUtils.isEmpty(parent)) {
parent = DB_PARENT;
}
if (StringUtils.isEmpty(label)) {
label = TreeSelectUtils.LABEL;
}
return collectionMap(id, parent, label, collection, args);
} catch (Exception e) {
log.error("多層下拉樹異常：", e);
return null;
}
}
/**
* 集合map的封裝
*/
private static List<TreeSelect> collectionMap(String id, String parent, String label,
@NotNull List<Map<String, Object>> collection, String... args) throws IllegalAccessException, NoSuchFieldException {
List<TreeSelect> list = new ArrayList<>();
// 找出所有的根節點
for (Map<String, Object> next : collection) {
Object parentId = next.get(parent);
if (isParentNodeMap(parentId, id, collection)) {
TreeSelect select = new TreeSelect();
select.setId(String.valueOf(next.get(id)));
select.setLabel(String.valueOf(next.get(label)));
list.add(select);
dynamicData(select, next, args);
}
}
// 依次添加子節點
for (TreeSelect select : list) {
addChildMap(select, id, parent, label, collection, args);
}
return list;
}
/**
* 添加跟隨下拉的字段
*
* @param treeSelect 當前節點
* @param e
* @param args 需要跟隨的字段
* @throws IllegalAccessException
* @throws NoSuchFieldException
*/
private static void dynamicData(@NotNull TreeSelect treeSelect, @NotNull Map<String, Object> e, String... args) throws IllegalAccessException, NoSuchFieldException {
if (args.length > 0) {
Map<String, Object> dataMap = new HashMap<>();
for (String arg : args) {
dataMap.put(arg, e.get(arg));
}
treeSelect.setDataMap(dataMap);
}
}
/**
* 為目標節點添加孩子節點
*
* @param node 目標節點
* @param collection 目標集合
* @param id ID 字段
* @param parent 父節點字段
* @param label 字節點字段
*/
private static void addChildMap(@NotNull TreeSelect node, String id, String parent, String label,
@NotNull List<Map<String, Object>> collection,
String... args) throws IllegalAccessException, NoSuchFieldException {
//父節點的id
String nodeId = node.getId();
//子節點集合
List<TreeSelect> children = new ArrayList<>();
for (Map<String, Object> e : collection) {
String parentId = String.valueOf(e.get(parent));
if (nodeId.equals(parentId)) {
// 將當前節點添加到目標節點的孩子節點
TreeSelect treeSelect = new TreeSelect();
treeSelect.setId(String.valueOf(e.get(id)));
treeSelect.setLabel(String.valueOf(e.get(label)));
dynamicData(treeSelect, e, args);
children.add(treeSelect);
node.setChildren(children);
// 遞歸添加子節點
addChildMap(treeSelect, id, parent, label, collection, args);
}
}
}
/**
* 判斷是否是根節點, 判斷方式為:
* 1、父節點編號為空或為 0, 則認為是根節點
* 2、父節點在集合中不存在父節點
*
* @param parentId 父節點編號
* @return 是否是根節點
*/
private static boolean isParentNodeMap(Object parentId, String id, @NotNull List<Map<String, Object>> collection) {
if (parentId == null) {
return true;
} else if (parentId instanceof String && (StringUtils.isEmpty(String.valueOf(parentId)) || parentId.equals("0"))) {
return true;
} else if (parentId instanceof Long && Long.valueOf(0).equals(parentId)) {
return true;
} else {
for (Map<String, Object> e : collection) {
Object o = e.get(id);
if (Objects.equals(o, parentId)) {
return false;
}
}
return true;
}
}
}
到此這篇關於Java實現級聯下拉結構的示例代碼的文章就介紹到這瞭,更多相關Java級聯下拉內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！