前言
在很多的實際場景中，我們需要得到某個包名下面所有的類，比如我們在使用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
