All Downloads are FREE. Search and download functionalities are using the official Maven repository.

leap.lang.beans.BeanTraverser Maven / Gradle / Ivy

The newest version!
/*
 *
 *  * Copyright 2019 the original author or authors.
 *  *
 *  * Licensed under the Apache License, Version 2.0 (the "License");
 *  * you may not use this file except in compliance with the License.
 *  * You may obtain a copy of the License at
 *  *
 *  *      http://www.apache.org/licenses/LICENSE-2.0
 *  *
 *  * Unless required by applicable law or agreed to in writing, software
 *  * distributed under the License is distributed on an "AS IS" BASIS,
 *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  * See the License for the specific language governing permissions and
 *  * limitations under the License.
 *
 */

package leap.lang.beans;

import leap.lang.Classes;
import leap.lang.Collections2;
import leap.lang.Enumerable;
import leap.lang.Enumerables;
import leap.lang.logging.Log;
import leap.lang.logging.LogFactory;

import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.function.BiConsumer;

public class BeanTraverser {
    private static final Log log = LogFactory.get(BeanTraverser.class);

    private static final Object UNRESOLVED = new Object();

    private final Object        bean;
    private final Set   traversed     = new HashSet<>();
    private final Set> skipClasses   = new HashSet<>();
    private final Set   skipPackages  = new HashSet<>();
    private final Set> acceptClasses = new HashSet<>();

    public BeanTraverser(Object bean) {
        this.bean = bean;
        skipPackages.add("java.");
    }

    public BeanTraverser acceptClassesOnly(Class... cs) {
        Collections2.addAll(acceptClasses, cs);
        return this;
    }

    public BeanTraverser skipClasses(Class... cs) {
        Collections2.addAll(skipClasses, cs);
        return this;
    }

    public BeanTraverser skipPackages(String... pkgs) {
        Collections2.addAll(skipPackages, pkgs);
        return this;
    }

    public void traverse(BiConsumer func) {
        traverse(ValMeta.ROOT, bean, func);
    }

    protected void traverse(ValMeta meta, Object val, BiConsumer func) {
        if (null != val && traversed.contains(val)) {
            return;
        }

        func.accept(meta, val);

        if (null == val) {
            return;
        }

        traversed.add(val);

        if (val instanceof Map) {
            traverseMap((Map) val, func);
            return;
        }

        Enumerable e = Enumerables.tryOf(val);
        if (null != e) {
            traverseEnumerable(val, e, func);
            return;
        }

        if (!Classes.isSimpleValueType(val.getClass())) {
            if (skipType(val.getClass())) {
                return;
            }
            traverseBean(val, func);
        }
    }

    protected boolean skipType(Class type) {
        if (!acceptClasses.isEmpty()) {
            boolean accept = false;
            for (Class c : acceptClasses) {
                if (c.isAssignableFrom(type)) {
                    accept = true;
                    break;
                }
            }
            if (!accept) {
                return true;
            }
        }

        for (String pkg : skipPackages) {
            if (Classes.getPackageName(type).startsWith(pkg)) {
                return true;
            }
        }

        for (Class c : skipClasses) {
            if (c.isAssignableFrom(type)) {
                return true;
            }
        }
        return false;
    }

    protected void traverseMap(Map map, BiConsumer func) {
        map.forEach((k, v) -> {
            traverse(new ValMeta(map, k.toString()), v, func);
        });
    }

    protected void traverseEnumerable(Object raw, Enumerable e, BiConsumer func) {
        for (int i = 0; i < e.size(); i++) {
            Object v = e.get(i);
            traverse(new ValMeta(raw, i), v, func);
        }
    }

    protected void traverseBean(Object bean, BiConsumer func) {
        for (BeanProperty bp : BeanType.of(bean.getClass()).getProperties()) {
            if (!bp.isReadable()) {
                continue;
            }
            if (skipType(bp.getType())) {
                continue;
            }
            Object p;
            try {
                p = bp.getValue(bean);
            } catch (Exception e) {
                log.warn("Err get property, {}" + e.getMessage(), e);
                p = UNRESOLVED;
            }
            if (p != UNRESOLVED) {
                traverse(new ValMeta(bean, bp), p, func);
            }
        }
    }

    /**
     * The meta info of value.
     */
    public static class ValMeta {
        private static final ValMeta ROOT = new ValMeta(null, null, null, null, true);

        private final Object       parent;
        private final String       name;
        private final Integer      index;
        private final boolean      root;
        private final BeanProperty property;

        protected ValMeta(Object parent, String name) {
            this(parent, name, null, null, false);
        }

        protected ValMeta(Object parent, BeanProperty property) {
            this(parent, property.getName(), null, property, false);
        }

        protected ValMeta(Object parent, Integer index) {
            this(parent, null, index, null, false);
        }

        private ValMeta(Object parent, String name, Integer index, BeanProperty property, boolean root) {
            this.parent = parent;
            this.name = name;
            this.index = index;
            this.property = property;
            this.root = root;
        }

        public Object getParent() {
            return parent;
        }

        public String getName() {
            return name;
        }

        public Integer getIndex() {
            return index;
        }

        public BeanProperty getProperty() {
            return property;
        }

        public boolean isRoot() {
            return root;
        }
    }
}