前言
在很多的实际场景中，我们需要得到某个包名下面所有的类，比如我们在使用SpringMVC的时候，知道SpringMVC可以扫描指定包下的所有类，在平时的开发中，我们也有这样的场景，所以今天写一个扫描包的工具类，分享出来供大家参考学习，下面话不多说了，来一起看看详细的介绍吧。
代码如下：
java" id="highlighter_224046">
|
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
|
package com.gujin.utils;import java.io.File;import java.io.FileFilter;import java.io.IOException;import java.net.JarURLConnection;import java.net.URL;import java.net.URLDecoder;import java.util.ArrayList;import java.util.Enumeration;import java.util.List;import java.util.jar.JarEntry;import java.util.jar.JarFile;public class HQScanPackage{ /** 是否循环迭代 **/ boolean recursive = true; /** 包名集合 **/ private List<String> packageNames = new ArrayList<String>(); /** 过滤器 **/ private HQScanPackageFilter filter = null; /** 监听器 **/ private HQScanPackageListener listener = null; /** * 是否循环迭代 * * @return */ public boolean isRecursive() { return recursive; } /** * 设置是否循环迭代 * * @param recursive */ public void setRecursive(boolean recursive) { this.recursive = recursive; } /** * 获得过滤器 * * @return */ public HQScanPackageFilter getFilter() { return filter; } /** * 设置过滤器 * * @param filter */ public void setFilter(HQScanPackageFilter filter) { this.filter = filter; } /** * 获得监听器 * * @return */ public HQScanPackageListener getListener() { return listener; } /** * 设置监听器 * * @param listener */ public void setListener(HQScanPackageListener listener) { this.listener = listener; } /** * 添加扫描包 * * @param packageName */ public void addPackage(String packageName) { if (packageName == null || !packageName.matches("[\\w]+(\\.[\\w]+)*")) { throw new IllegalArgumentException("非法包名."); } this.packageNames.add(packageName); } /** * 清空扫描包 */ public void clearPackage() { this.packageNames.clear(); } /** * 扫描 */ public void scan() { for (String packageName : packageNames) { scan(packageName); } } /** * 是否接受 * * @param clazz * @return */ private boolean accept(Class<?> clazz) { if (this.filter != null) { return this.filter.accept(clazz); } return true; } /** * 触发扫描到合法类 * * @param clazz * @return */ private void trrigerOnScanClass(Class<?> clazz) { if (this.listener != null) { this.listener.onScanClass(clazz); } } /** * 扫描到类 * * @param clazz * @return */ private void onScanClass(Class<?> clazz) { if (accept(clazz)) { trrigerOnScanClass(clazz); } } /** * 从包package中获取所有的Class * * @param packageName * @return */ private void scan(String packageName) { // 获取包的名字 并进行替换 String packageDirName = packageName.replace('.', '/'); // 定义一个枚举的集合 并进行循环来处理这个目录下的things Enumeration<URL> dirs = null; try { dirs = Thread.currentThread().getContextClassLoader() .getResources(packageDirName); // 循环迭代下去 while (dirs.hasMoreElements()) { // 获取下一个元素 URL url = dirs.nextElement(); // 得到协议的名称 String protocol = url.getProtocol(); // 如果是以文件的形式保存在服务器上 if ("file".equals(protocol)) { // 获取包的物理路径 String filePath = URLDecoder.decode(url.getFile(), "UTF-8"); // 以文件的方式扫描整个包下的文件 并添加到集合中 findAndAddClassesInPackageByFile(packageName, filePath); } else if ("jar".equals(protocol)) { // 如果是jar包文件 // 定义一个JarFile JarFile jar = null; try { // 获取jar jar = ((JarURLConnection) url.openConnection()).getJarFile(); // 从此jar包 得到一个枚举类 Enumeration<JarEntry> entries = jar.entries(); // 同样的进行循环迭代 while (entries.hasMoreElements()) { // 获取jar里的一个实体 可以是目录 和一些jar包里的其他文件 如META-INF等文件 JarEntry entry = entries.nextElement(); String name = entry.getName(); // 如果是以/开头的 if (name.charAt(0) == '/') { // 获取后面的字符串 name = name.substring(1); } // 如果前半部分和定义的包名相同 if (name.startsWith(packageDirName)) { int idx = name.lastIndexOf('/'); // 如果以"/"结尾 是一个包 if (idx != -1) { // 获取包名 把"/"替换成"." packageName = name.substring(0, idx).replace('/', '.'); } // 如果可以迭代下去 并且是一个包 if ((idx != -1) || recursive) { // 如果是一个.class文件 而且不是目录 if (name.endsWith(".class") && !entry.isDirectory()) { // 去掉后面的".class" 获取真正的类名 String className = name.substring( packageName.length() + 1, name.length() - 6); try { // 添加到classes // 使用Class.forName会触发类静态方法 Class<?> clazz = Thread.currentThread() .getContextClassLoader().loadClass( packageName + '.' + className); onScanClass(clazz); } catch (ClassNotFoundException e) { System.err.println("加载类出错"); } } } } } } catch (IOException e) { System.err.println("在扫描用户定义视图时从jar包获取文件出错"); e.printStackTrace(); } } } } catch (IOException e) { System.err.println("扫描出错"); e.printStackTrace(); } } /** * 以文件的形式来获取包下的所有Class * * @param packageName * @param packagePath */ private void findAndAddClassesInPackageByFile(String packageName, String packagePath) { // 获取此包的目录 建立一个File File dir = new File(packagePath); // 如果不存在或者 也不是目录就直接返回 if (!dir.exists() || !dir.isDirectory()) { System.err.println("用户定义包名 " + packageName + " 下没有任何文件"); return; } // 如果存在 就获取包下的所有文件 包括目录 File[] dirfiles = dir.listFiles(new FileFilter() { // 自定义过滤规则 如果可以循环(包含子目录) 或则是以.class结尾的文件(编译好的java类文件) public boolean accept(File file) { return (recursive && file.isDirectory()) || (file.getName().endsWith(".class")); } }); // 循环所有文件 for (File file : dirfiles) { // 如果是目录 则继续扫描 if (file.isDirectory()) { findAndAddClassesInPackageByFile(packageName + "." + file.getName(), file.getAbsolutePath()); } else { // 如果是java类文件 去掉后面的.class 只留下类名 String className = file.getName().substring(0, file.getName().length() - 6); try { Class<?> clazz = Thread.currentThread().getContextClassLoader() .loadClass(packageName + '.' + className); onScanClass(clazz); } catch (ClassNotFoundException e) { System.err.println("添加用户自定义视图类错误 找不到此类的.class文件"); e.printStackTrace(); } } } } /** * 扫描包过滤器 * * @author jianggujin * */ public static interface HQScanPackageFilter { /** * 是否接受 * * @param clazz * @return */ public boolean accept(Class<?> clazz); } /** * 扫描包监听 * * @author jianggujin * */ public static interface HQScanPackageListener { /** * 扫描到合法类执行 * * @param clazz */ public void onScanClass(Class<?> clazz); } public static void main(String[] args) { HQScanPackage scanPackage = new HQScanPackage(); scanPackage.addPackage(HQScanPackage.class.getPackage().getName()); scanPackage.setFilter(new HQScanPackageFilter() { @Override public boolean accept(Class<?> clazz) { return true; } }); scanPackage.setListener(new HQScanPackageListener() { @Override public void onScanClass(Class<?> clazz) { System.out.println(clazz); } }); scanPackage.scan(); }} |
运行可以得到如下结果：
|
1
2
3
4
5
6
|
class com.gujin.utils.HQScanPackage$1class com.gujin.utils.HQScanPackage$2class com.gujin.utils.HQScanPackage$3interface com.gujin.utils.HQScanPackage$HQScanPackageFilter interface com.gujin.utils.HQScanPackage$HQScanPackageListener class com.gujin.utils.HQScanPackage |
总结
以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对服务器之家的支持。
原文链接：http://blog.csdn.net/jianggujin/article/details/51361080
