com.feilong.context.BeanLogMessageBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation

feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.

There is a newer version: 4.0.8

Show newest version

/*
 * Copyright (C) 2008 feilong
 *
 * 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 com.feilong.context;

import java.util.Map;

import com.feilong.core.lang.reflect.FieldUtil;
import com.feilong.json.JsonUtil;
import com.feilong.core.Validate;
import com.feilong.tools.slf4j.Slf4jUtil;

/**
 * bean message 信息构造器.
 *
 * @author feilong
 * @since 1.12.0 move from spring
 */
public final class BeanLogMessageBuilder{

    /** Don't let anyone instantiate this class. */
    private BeanLogMessageBuilder(){
        //AssertionError不是必须的. 但它可以避免不小心在类的内部调用构造器. 保证该类在任何情况下都不会被实例化.
        //see 《Effective Java》 2nd
        throw new AssertionError("No " + getClass().getName() + " instances for you!");
    }

    //---------------------------------------------------------------

    /**
     * 生成对象字段相关日志信息.
     *
     * @param obj
     *            the obj
     * @return 如果 obj 是null,抛出 {@link NullPointerException}

     */
    public static String buildFieldsMessage(Object obj){
        Validate.notNull(obj, "obj can't be null!");

        Map map = FieldUtil.getAllFieldNameAndValueMap(obj);
        return build(obj, JsonUtil.format(map));
    }

    //---------------------------------------------------------------

    /**
     * 生成对象字段相关日志信息.
     *
     * @param obj
     *            the obj
     * @return 如果 obj 是null,抛出 {@link NullPointerException}

     * @since 1.11.5
     */
    public static String buildFieldsSimpleMessage(Object obj){
        Validate.notNull(obj, "obj can't be null!");

        Map map = FieldUtil.getAllFieldNameAndValueMap(obj);
        return build(obj, JsonUtil.formatSimpleMap(map));
    }

    //---------------------------------------------------------------

    /**
     * Builds the.
     *
     * @param obj
     *            the obj
     * @param mapInfo
     *            the map info
     * @return the string
     * @since 1.11.5
     */
    private static String build(Object obj,String mapInfo){
        return Slf4jUtil.format("[{}] field's value map:\n[{}]", obj.getClass().getCanonicalName(), mapInfo);
    }
}