📄 log4jxmlformatter.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /><title>Log4jXmlFormatter xref</title><link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../apidocs/org/apache/mina/util/Log4jXmlFormatter.html">View Javadoc</a></div><pre><a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.mina.util;<a name="2" href="#2">2</a> <a name="3" href="#3">3</a> <strong class="jxr_keyword">import</strong> org.slf4j.MDC;<a name="4" href="#4">4</a> <strong class="jxr_keyword">import</strong> org.slf4j.helpers.BasicMDCAdapter;<a name="5" href="#5">5</a> <a name="6" href="#6">6</a> <strong class="jxr_keyword">import</strong> java.util.logging.Formatter;<a name="7" href="#7">7</a> <strong class="jxr_keyword">import</strong> java.util.logging.LogRecord;<a name="8" href="#8">8</a> <strong class="jxr_keyword">import</strong> java.util.Set;<a name="9" href="#9">9</a> <strong class="jxr_keyword">import</strong> java.util.Arrays;<a name="10" href="#10">10</a> <a name="11" href="#11">11</a> <em class="jxr_javadoccomment">/**</em><a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * Implementation of {@link java.util.logging.Formatter} that generates xml in the log4j format.</em><a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * <p></em><a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * The generated xml corresponds 100% with what is generated by</em><a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * log4j's <a href=<a href="http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/XMLLayout.html" target="alexandria_uri">http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/XMLLayout.html</a>">XMLLayout</a></em><a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * <p></em><a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * The MDC properties will only be correct when <code>format</code> is called from the same thread</em><a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> * that generated the LogRecord.</em><a name="19" href="#19">19</a> <em class="jxr_javadoccomment"> * <p></em><a name="20" href="#20">20</a> <em class="jxr_javadoccomment"> * The file and line attributes in the locationInfo element will always be "?"</em><a name="21" href="#21">21</a> <em class="jxr_javadoccomment"> * since java.util.logging.LogRecord does not provide that info.</em><a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * <p></em><a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * The implementation is heavily based on org.apache.log4j.xml.XMLLayout</em><a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * </p></em><a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> */</em><a name="26" href="#26">26</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> Log4jXmlFormatter <strong class="jxr_keyword">extends</strong> Formatter {<a name="27" href="#27">27</a> <a name="28" href="#28">28</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_SIZE = 256;<a name="29" href="#29">29</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> UPPER_LIMIT = 2048;<a name="30" href="#30">30</a> <a name="31" href="#31">31</a> <strong class="jxr_keyword">private</strong> StringBuffer buf = <strong class="jxr_keyword">new</strong> StringBuffer(DEFAULT_SIZE);<a name="32" href="#32">32</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> locationInfo = false;<a name="33" href="#33">33</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> properties = false;<a name="34" href="#34">34</a> <a name="35" href="#35">35</a> <em class="jxr_javadoccomment">/**</em><a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * The <b>LocationInfo</b> option takes a boolean value. By default,</em><a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * it is set to false which means there will be no location</em><a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * information output by this layout. If the the option is set to</em><a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * true, then the file name and line number of the statement at the</em><a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * origin of the log statement will be output.</em><a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em><a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @param flag whether locationInfo should be output by this layout</em><a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em><a name="44" href="#44">44</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLocationInfo(<strong class="jxr_keyword">boolean</strong> flag) {<a name="45" href="#45">45</a> locationInfo = flag;<a name="46" href="#46">46</a> }<a name="47" href="#47">47</a> <a name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em><a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Returns the current value of the <b>LocationInfo</b> option.</em><a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> *</em><a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @return whether locationInfo will be output by this layout</em><a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em><a name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> getLocationInfo() {<a name="54" href="#54">54</a> <strong class="jxr_keyword">return</strong> locationInfo;<a name="55" href="#55">55</a> }<a name="56" href="#56">56</a> <a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em><a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * Sets whether MDC key-value pairs should be output, default false.</em><a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> *</em><a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @param flag new value.</em><a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> */</em><a name="62" href="#62">62</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setProperties(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> flag) {<a name="63" href="#63">63</a> properties = flag;<a name="64" href="#64">64</a> }<a name="65" href="#65">65</a> <a name="66" href="#66">66</a> <em class="jxr_javadoccomment">/**</em><a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * Gets whether MDC key-value pairs should be output.</em><a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> *</em><a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @return true if MDC key-value pairs are output.</em><a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em><a name="71" href="#71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> getProperties() {<a name="72" href="#72">72</a> <strong class="jxr_keyword">return</strong> properties;<a name="73" href="#73">73</a> }<a name="74" href="#74">74</a> <a name="75" href="#75">75</a> <strong class="jxr_keyword">public</strong> String format(<strong class="jxr_keyword">final</strong> LogRecord record) {<a name="76" href="#76">76</a> <em class="jxr_comment">// Reset working buffer. If the buffer is too large, then we need a new</em><a name="77" href="#77">77</a> <em class="jxr_comment">// one in order to avoid the penalty of creating a large array.</em><a name="78" href="#78">78</a> <strong class="jxr_keyword">if</strong> (buf.capacity() > UPPER_LIMIT) {<a name="79" href="#79">79</a> buf = <strong class="jxr_keyword">new</strong> StringBuffer(DEFAULT_SIZE);<a name="80" href="#80">80</a> } <strong class="jxr_keyword">else</strong> {<a name="81" href="#81">81</a> buf.setLength(0);<a name="82" href="#82">82</a> }<a name="83" href="#83">83</a> buf.append(<span class="jxr_string">"<log4j:event logger=\""</span>);<a name="84" href="#84">84</a> buf.append(Transform.escapeTags(record.getLoggerName()));<a name="85" href="#85">85</a> buf.append(<span class="jxr_string">"\" timestamp=\""</span>);<a name="86" href="#86">86</a> buf.append(record.getMillis());<a name="87" href="#87">87</a> buf.append(<span class="jxr_string">"\" level=\""</span>);<a name="88" href="#88">88</a> <a name="89" href="#89">89</a> buf.append(Transform.escapeTags(record.getLevel().getName()));<a name="90" href="#90">90</a> buf.append(<span class="jxr_string">"\" thread=\""</span>);<a name="91" href="#91">91</a> buf.append(String.valueOf(record.getThreadID()));<a name="92" href="#92">92</a> buf.append(<span class="jxr_string">"\">\r\n"</span>);<a name="93" href="#93">93</a> <a name="94" href="#94">94</a> buf.append(<span class="jxr_string">"<log4j:message><![CDATA["</span>);<a name="95" href="#95">95</a> <em class="jxr_comment">// Append the rendered message. Also make sure to escape any</em><a name="96" href="#96">96</a> <em class="jxr_comment">// existing CDATA sections.</em><a name="97" href="#97">97</a> Transform.appendEscapingCDATA(buf, record.getMessage());<a name="98" href="#98">98</a> buf.append(<span class="jxr_string">"]]></log4j:message>\r\n"</span>);<a name="99" href="#99">99</a> <a name="100" href="#100">100</a> <strong class="jxr_keyword">if</strong> (record.getThrown() != <strong class="jxr_keyword">null</strong>) {<a name="101" href="#101">101</a> String[] s = Transform.getThrowableStrRep(record.getThrown());<a name="102" href="#102">102</a> <strong class="jxr_keyword">if</strong> (s != <strong class="jxr_keyword">null</strong>) {<a name="103" href="#103">103</a> buf.append(<span class="jxr_string">"<log4j:throwable><![CDATA["</span>);<a name="104" href="#104">104</a> <strong class="jxr_keyword">for</strong> (String value : s) {<a name="105" href="#105">105</a> Transform.appendEscapingCDATA(buf, value);<a name="106" href="#106">106</a> buf.append(<span class="jxr_string">"\r\n"</span>);<a name="107" href="#107">107</a> }<a name="108" href="#108">108</a> buf.append(<span class="jxr_string">"]]></log4j:throwable>\r\n"</span>);<a name="109" href="#109">109</a> }<a name="110" href="#110">110</a> }<a name="111" href="#111">111</a> <a name="112" href="#112">112</a> <strong class="jxr_keyword">if</strong> (locationInfo) {<a name="113" href="#113">113</a> buf.append(<span class="jxr_string">"<log4j:locationInfo class=\""</span>);<a name="114" href="#114">114</a> buf.append(Transform.escapeTags(record.getSourceClassName()));<a name="115" href="#115">115</a> buf.append(<span class="jxr_string">"\" method=\""</span>);<a name="116" href="#116">116</a> buf.append(Transform.escapeTags(record.getSourceMethodName()));<a name="117" href="#117">117</a> buf.append(<span class="jxr_string">"\" file=\"?\" line=\"?\"/>\r\n"</span>);<a name="118" href="#118">118</a> }<a name="119" href="#119">119</a> <a name="120" href="#120">120</a> <strong class="jxr_keyword">if</strong> (properties) {<a name="121" href="#121">121</a> <strong class="jxr_keyword">if</strong> (MDC.getMDCAdapter() instanceof BasicMDCAdapter) {<a name="122" href="#122">122</a> BasicMDCAdapter mdcAdapter = (BasicMDCAdapter) MDC.getMDCAdapter();<a name="123" href="#123">123</a> Set keySet = mdcAdapter.getKeys();<a name="124" href="#124">124</a> <strong class="jxr_keyword">if</strong> (keySet != <strong class="jxr_keyword">null</strong> && keySet.size() > 0) {<a name="125" href="#125">125</a> buf.append(<span class="jxr_string">"<log4j:properties>\r\n"</span>);<a name="126" href="#126">126</a> Object[] keys = keySet.toArray();<a name="127" href="#127">127</a> Arrays.sort(keys);<a name="128" href="#128">128</a> <strong class="jxr_keyword">for</strong> (Object key1 : keys) {<a name="129" href="#129">129</a> String key = key1.toString();<a name="130" href="#130">130</a> Object val = mdcAdapter.get(key);<a name="131" href="#131">131</a> <strong class="jxr_keyword">if</strong> (val != <strong class="jxr_keyword">null</strong>) {<a name="132" href="#132">132</a> buf.append(<span class="jxr_string">"<log4j:data name=\""</span>);<a name="133" href="#133">133</a> buf.append(Transform.escapeTags(key));<a name="134" href="#134">134</a> buf.append(<span class="jxr_string">"\" value=\""</span>);<a name="135" href="#135">135</a> buf.append(Transform.escapeTags(String.valueOf(val)));<a name="136" href="#136">136</a> buf.append(<span class="jxr_string">"\"/>\r\n"</span>);<a name="137" href="#137">137</a> }<a name="138" href="#138">138</a> }<a name="139" href="#139">139</a> buf.append(<span class="jxr_string">"</log4j:properties>\r\n"</span>);<a name="140" href="#140">140</a> }<a name="141" href="#141">141</a> }<a name="142" href="#142">142</a> }<a name="143" href="#143">143</a> buf.append(<span class="jxr_string">"</log4j:event>\r\n\r\n"</span>);<a name="144" href="#144">144</a> <a name="145" href="#145">145</a> <strong class="jxr_keyword">return</strong> buf.toString();<a name="146" href="#146">146</a> }<a name="147" href="#147">147</a> <a name="148" href="#148">148</a> }</pre><hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -