1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/*******************************************************************************
* Copyright (c) 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt
*
* Contributors:
* Matthew Webster - initial implementation
* Sian January
*******************************************************************************/
package org.aspectj.lib.tracing;
import java.io.File;
import java.lang.reflect.Array;
import java.net.URL;
import java.text.SimpleDateFormat;
import java.util.Collection;
import java.util.Date;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.reflect.CodeSignature;
/**
* This simple abstract aspect is enabled by default and traces method
* signatures as well as arguments to stderr. An abstract scoping pointcut
* is provided for concrete, user-supplied sub-aspect to determine which
* classes should be traced.
*/
public abstract aspect SimpleTracing extends Tracing {
/**
* Sub-aspects <b>must</b> implement this pointcut to determine what to trace
*/
protected abstract pointcut tracingScope ();
private static SimpleDateFormat timeFormat;
/**
* Enabled or disable tracing
*
* @param enabled
*/
public static void setEnabled (boolean enabled) {
tracingEnabled = enabled;
}
public static boolean getEnabled () {
return tracingEnabled;
}
/*
* Tracing pattern 2: Use if() pointcut to efficiently determine when to trace
*
* Tracing pattern 3: Use -XlazyTjp compiler option
*/
protected pointcut shouldTrace () :
if(tracingEnabled) && tracingScope();
private static boolean tracingEnabled = getBoolean("org.aspectj.lib.tracing",true);
private static boolean getBoolean (String name, boolean def) {
String defaultValue = String.valueOf(def);
String value = System.getProperty(name,defaultValue);
return Boolean.valueOf(value).booleanValue();
}
/*
* Tracing template methods
*/
protected void enter (JoinPoint jp, Object obj) {
CodeSignature signature = (CodeSignature)jp.getSignature();
println(signature.getDeclaringType(),formatMessage(">",signature.getDeclaringTypeName(),signature.getName(),obj,jp.getArgs()));
// println("> " + signature.toShortString() + " " + formatParam("obj",obj) + " " + formatArgs(signature.getParameterNames(),jp.getArgs()));
}
protected void enter (JoinPoint jp) {
CodeSignature signature = (CodeSignature)jp.getSignature();
println(signature.getDeclaringType(),formatMessage(">",signature.getDeclaringTypeName(),signature.getName(),null,jp.getArgs()));
// println("> " + jp.getSignature().toShortString() + " " + formatArgs(signature.getParameterNames(),jp.getArgs()));
}
protected void exit (JoinPoint.StaticPart sjp, Object ret) {
CodeSignature signature = (CodeSignature)sjp.getSignature();
println(signature.getDeclaringType(),formatMessage("<",signature.getDeclaringTypeName(),signature.getName(),ret,null));
// println("< " + sjp.getSignature().toShortString() + " " + formatParam("ret",ret));
}
protected void exit (JoinPoint.StaticPart sjp) {
CodeSignature signature = (CodeSignature)sjp.getSignature();
println(signature.getDeclaringType(),formatMessage("<",signature.getDeclaringTypeName(),signature.getName(),null,null));
// println("< " + sjp.getSignature().toShortString());
}
protected void exception (JoinPoint.StaticPart sjp, Throwable th) {
CodeSignature signature = (CodeSignature)sjp.getSignature();
println(signature.getDeclaringType(),formatMessage("E",signature.getName(),th));
// println("E " + sjp.getSignature().toShortString() + " " + th.toString());
}
/*
* Formatting
*/
protected String formatMessage(String kind, String className, String methodName, Object thiz, Object[] args) {
StringBuffer message = new StringBuffer();
Date now = new Date();
message.append(formatDate(now)).append(" ");
message.append(Thread.currentThread().getName()).append(" ");
message.append(kind).append(" ");
message.append(className);
message.append(".").append(methodName);
if (thiz != null) message.append(" ").append(formatObj(thiz));
if (args != null) message.append(" ").append(formatArgs(args));
return message.toString();
}
protected String formatMessage(String kind, String text, Throwable th) {
StringBuffer message = new StringBuffer();
Date now = new Date();
message.append(formatDate(now)).append(" ");
message.append(Thread.currentThread().getName()).append(" ");
message.append(kind).append(" ");
message.append(text);
if (th != null) message.append(" ").append(formatObj(th));
return message.toString();
}
/**
* Format arguments into a comma separated list
*
* @param names array of argument names
* @param args array of arguments
* @return the formated list
*/
protected String formatArgs(Object[] args) {
StringBuffer sb = new StringBuffer();
for (int i = 0; i < args.length; i++) {
sb.append(formatObj(args[i]));
if (i < args.length-1) sb.append(", ");
}
return sb.toString();
}
/**
* Format objects safely avoiding toString which can cause recursion,
* NullPointerExceptions or highly verbose results.
*
* @param obj parameter to be formatted
* @return the formated parameter
*/
protected Object formatObj(Object obj) {
/* These classes have a safe implementation of toString() */
if (obj == null
|| obj instanceof String
|| obj instanceof Number
|| obj instanceof Boolean
|| obj instanceof Exception
|| obj instanceof Character
|| obj instanceof Class
|| obj instanceof File
|| obj instanceof StringBuffer
|| obj instanceof URL
) return obj;
else if (obj.getClass().isArray()) {
return formatArray(obj);
}
else if (obj instanceof Collection) {
return formatCollection((Collection)obj);
}
else try {
/* Use classname@hashcode */
return obj.getClass().getName() + "@" + Integer.toHexString(System.identityHashCode(obj));
/* Object.hashCode() can be override and may thow an exception */
} catch (Exception ex) {
return obj.getClass().getName() + "@FFFFFFFF";
}
}
protected String formatArray (Object obj) {
return obj.getClass().getComponentType().getName() + "[" + Array.getLength(obj) + "]";
}
protected String formatCollection (Collection c) {
return c.getClass().getName() + "(" + c.size() + ")";
}
private static String formatDate (Date date) {
if (timeFormat == null) {
timeFormat = new SimpleDateFormat("HH:mm:ss.SSS");
}
return timeFormat.format(date);
}
/**
* Template method that allows choice of destination for output
*
* @param s message to be traced
*/
protected void println (Class clazz, String s) {
System.err.println(s);
}
}
|
