package dp.log;
import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.logging.log4j.core.Layout;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.Configuration;
import org.apache.logging.log4j.core.config.DefaultConfiguration;
import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
import org.apache.logging.log4j.core.config.plugins.PluginElement;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
import org.apache.logging.log4j.core.layout.AbstractStringLayout;
import org.apache.logging.log4j.core.layout.ByteBufferDestination;
import org.apache.logging.log4j.core.layout.Encoder;
import org.apache.logging.log4j.core.layout.PatternSelector;
import org.apache.logging.log4j.core.pattern.LogEventPatternConverter;
import org.apache.logging.log4j.core.pattern.PatternFormatter;
import org.apache.logging.log4j.core.pattern.PatternParser;
import org.apache.logging.log4j.core.pattern.RegexReplacement;
import org.apache.logging.log4j.util.Strings;
/**
* 定制的输出层，可自由组织要输出的text文本
*
* @author dongp
*
*/
@Plugin(name = "CustomPatternLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true)
public class CustomPatternLayout extends AbstractStringLayout {
/**
* 定制输出文本
*
* @param text
* @return
*/
public static String customize(String text) {
return LogUtil.customize(text);
}
/**
* Default pattern string for log output. Currently set to the string
* <b>"%m%n"</b> which just prints the application supplied message.
*/
public static final String DEFAULT_CONVERSION_PATTERN = "%m%n";
/**
* A conversion pattern equivalent to the TTCCLayout. Current value is <b>%r
* [%t] %p %c %notEmpty{%x }- %m%n</b>.
*/
public static final String TTCC_CONVERSION_PATTERN = "%r [%t] %p %c %notEmpty{%x }- %m%n";
/**
* A simple pattern. Current value is <b>%d [%t] %p %c - %m%n</b>.
*/
public static final String SIMPLE_CONVERSION_PATTERN = "%d [%t] %p %c - %m%n";
/** Key to identify pattern converters. */
public static final String KEY = "Converter";
/**
* Conversion pattern.
*/
private final String conversionPattern;
private final PatternSelector patternSelector;
private final Serializer eventSerializer;
/**
* Constructs a LayoutTest using the supplied conversion pattern.
*
* @param config
* The Configuration.
* @param replace
* The regular expression to match.
* @param eventPattern
* conversion pattern.
* @param patternSelector
* The PatternSelector.
* @param charset
* The character set.
* @param alwaysWriteExceptions
* Whether or not exceptions should always be handled in this
* pattern (if {@code true}, exceptions will be written even if
* the pattern does not specify so).
* @param noConsoleNoAnsi
* If {@code "true"} (default) and {@link System#console()} is
* null, do not output ANSI escape codes
* @param headerPattern
* header conversion pattern.
* @param footerPattern
* footer conversion pattern.
*/
private CustomPatternLayout(final Configuration config, final RegexReplacement replace,
final String eventPattern, final PatternSelector patternSelector, final Charset charset,
final boolean alwaysWriteExceptions, final boolean noConsoleNoAnsi,
final String headerPattern, final String footerPattern) {
super(config, charset,
createSerializer(config, replace, headerPattern, null, patternSelector,
alwaysWriteExceptions, noConsoleNoAnsi),
createSerializer(config, replace, footerPattern, null, patternSelector,
alwaysWriteExceptions, noConsoleNoAnsi));
this.conversionPattern = eventPattern;
this.patternSelector = patternSelector;
this.eventSerializer = createSerializer(config, replace, eventPattern,
DEFAULT_CONVERSION_PATTERN, patternSelector, alwaysWriteExceptions,
noConsoleNoAnsi);
}
public static Serializer createSerializer(final Configuration configuration,
final RegexReplacement replace, final String pattern, final String defaultPattern,
final PatternSelector patternSelector, final boolean alwaysWriteExceptions,
final boolean noConsoleNoAnsi) {
if (Strings.isEmpty(pattern) && Strings.isEmpty(defaultPattern)) {
return null;
}
if (patternSelector == null) {
try {
final PatternParser parser = createPatternParser(configuration);
final List<PatternFormatter> list = parser.parse(
pattern == null ? defaultPattern : pattern, alwaysWriteExceptions,
noConsoleNoAnsi);
final PatternFormatter[] formatters = list.toArray(new PatternFormatter[0]);
return new PatternSerializer(formatters, replace);
} catch (final RuntimeException ex) {
throw new IllegalArgumentException("Cannot parse pattern '" + pattern + "'", ex);
}
}
return new PatternSelectorSerializer(patternSelector, replace);
}
/**
* Gets the conversion pattern.
*
* @return the conversion pattern.
*/
public String getConversionPattern() {
return conversionPattern;
}
/**
* Gets this LayoutTest's content format. Specified by:
* <ul>
* <li>Key: "structured" Value: "false"</li>
* <li>Key: "formatType" Value: "conversion" (format uses the keywords
* supported by OptionConverter)</li>
* <li>Key: "format" Value: provided "conversionPattern" param</li>
* </ul>
*
* @return Map of content format keys supporting LayoutTest
*/
@Override
public Map<String, String> getContentFormat() {
final Map<String, String> result = new HashMap<>();
result.put("structured", "false");
result.put("formatType", "conversion");
result.put("format", conversionPattern);
return result;
}
/**
* Formats a logging event to a writer.
*
* @param event
* logging event to be formatted.
* @return The event formatted as a String.
*/
@Override
public String toSerializable(final LogEvent event) {
return eventSerializer.toSerializable(event);
}
@Override
public void encode(final LogEvent event, final ByteBufferDestination destination) {
if (!(eventSerializer instanceof Serializer2)) {
super.encode(event, destination);
return;
}
final StringBuilder text = toText((Serializer2) eventSerializer, event, getStringBuilder());
final Encoder<StringBuilder> encoder = getStringBuilderEncoder();
encoder.encode(text, destination);
trimToMaxSize(text);
}
/**
* Creates a text representation of the specified log event and writes it
* into the specified StringBuilder.
* <p>
* Implementations are free to return a new StringBuilder if they can detect
* in advance that the specified StringBuilder is too small.
*/
private StringBuilder toText(final Serializer2 serializer, final LogEvent event,
final StringBuilder destination) {
return serializer.toSerializable(event, destination);
}
/**
* Creates a PatternParser.
*
* @param config
* The Configuration.
* @return The PatternParser.
*/
public static PatternParser createPatternParser(final Configuration config) {
if (config == null) {
return new PatternParser(config, KEY, LogEventPatternConverte
- 1
- 2
前往页