1.背景
一個大型項目往往需要幾人甚至是十幾人參與開發,大家編碼習慣不同,導致一個項目往往會出現幾個LogUtils類。經常出現Log的tag以人名命名。盡管軟件組長嚴令禁止,可是難免還是有漏網之魚。以下是常見的問題:
LogUtil有多個
Log tag 以人名命名
Glide.with傳入Application,沒有考量生命周期
使用BitmapFactory.decodeResource 加載圖片,同一個資源多次調用會重復加載
直接使用new Thread 去開啟一個線程
資源文件命令各種各樣
2.Lint介紹
lint是android studio自帶的靜態代碼分析工具,能夠對 Android 源代碼進行掃描和檢查,并發現可優化的代碼和潛在性的異常,從而方便開發人員盡早地予以處理。通常在做apk的性能優化
時,Lint也可以為我們提供幫助。【Analyze】->【InSpect Code】 掃描整個項目。可以檢測圖片是否 重復
,優化xml布局
等等
3.自定義Lint實現
當前環境:
Android studio 2020.3.1
gradle-6.5-all.zip
build:gradle:4.1.1
步驟1:新建一個項目
步驟2:new 一個 名為【check】的Android library
步驟3:new 一個名為【lintrule】的 java library
App 的build.gradle:
implementation project(path: ':check')
check的 build.gradle
/**
*在庫項目中使用這個新的配置來進行要包含在已發布的AAR中的lint檢查,如下所示。這意味著使用庫的項目也會應用這些lint檢查
*/
lintPublish project(':lintrule')
lintrule的 build.gradle
apply plugin: 'java'
dependencies {
compileOnly 'com.android.tools.lint:lint-api:27.0.1'
compileOnly 'com.android.tools.lint:lint-checks:27.0.1'
}
jar {
manifest {
attributes("Lint-Registry-v2": "com.example.lintrule.LintRegistry") //更改自己的注冊器
}
}
注意在高版本的gradle中,build.gradle 引入java插件是通過這種方式:
plugins {
id 'java-library'
id 'kotlin'
}
通過這種方式驗證的,我做過實驗最終無法顯示lint提示
項目環境搭建完畢,接下來正式開始編碼。在lintrule 庫中創建一個文件LogDetector.java 繼承Detector:
public class LogDetector extends Detector implements SourceCodeScanner {
public static String TAG="LogDetector ";
public static final Issue ISSUE = Issue.create(
"LogId", //第一無二的id即可
"不要直接使用Log", //描述信息
"不要直接使用Log", // 描述信息
Category.MESSAGES,
5,
Severity.WARNING,
new Implementation(LogDetector.class, Scope.JAVA_FILE_SCOPE)//文件類型意味著只掃描java文件
);
@Nullable
@Override
//根據名稱 去檢查方法
public List<String> getApplicableMethodNames() {
return Arrays.asList("v", "d", "i", "w", "e");//Log.d() Log.e() 等方法名
}
// 類似還有visitClass 包括Gradle的訪問
@Override
public void visitMethodCall(@NotNull JavaContext context, @NotNull UCallExpression node, @NotNull PsiMethod method) {
boolean isMemberInClass = context.getEvaluator().isMemberInClass(method, "android.util.Log");
boolean isMemberInSubClassOf = context.getEvaluator().isMemberInSubClassOf(method, "android.util.Log", true);
System.out.println(TAG+obj.getClass().getName());//可以通過gradlew lint 看到打印信息
if (isMemberInClass || isMemberInSubClassOf) {
context.report(ISSUE, node, context.getLocation(node), "不要直接使用Log");//report 上報提示信息給開發者
}
}
}
Detector:中文意思 探測器,檢測
SourceCodeScanner:指定掃描文件類型,提供對應的方法,還有Detector.GradleScanner
,ClassScanner
等等
有了Detector,還需要將Detector 注入到lint 體系中去。 重寫IssueRegistry 類的getIssues方法
public class LintRegistry extends IssueRegistry {
@NotNull
@Override
public List<Issue> getIssues() {
return Arrays.asList(
LogDetector.ISSUE
);
}
}
之后一定要在lintrule的 build.gradle 加入下面代碼
jar {
manifest {
attributes("Lint-Registry-v2": "com.example.lintrule.LintRegistry")//自己注冊器的包名+類名
}
}
網上很多文章都要求如下配置, 實際測試發現不需要。只要加入上面代碼 即可!
之后:build gradle 或者 gradlw lint 都可以刷新lint規則,萬一還不行,就重啟看看
ps: 在【Terminal】中可以通過 gradlew lint
命令 查看 日志的輸出
實驗結果:
以上就是Lint的基本使用。lint 可以檢測到方法名。那么它能否檢測參數值
呢?。如何給Glide.with 傳入Application 提示?
4.檢測Glide.with傳入Application
public class GlideWithDetector extends Detector implements SourceCodeScanner {
public static final Issue ISSUE = Issue.create(
"glideWithId",
"Glide.with盡量別傳入Application",
"Glide.with盡量別傳入Application", // no need
Category.MESSAGES,
7,
Severity.WARNING,
new Implementation(GlideWithDetector.class, Scope.JAVA_FILE_SCOPE)
);
@Nullable
@Override
public List<String> getApplicableMethodNames() {
return Arrays.asList("with");
}
@Override
public void visitMethodCall(@NotNull JavaContext context, @NotNull UCallExpression node, @NotNull PsiMethod method) {
boolean isMemberInClass = context.getEvaluator().isMemberInClass(method, "com.bumptech.glide.Glide");
boolean isMemberInSubClassOf = context.getEvaluator().isMemberInSubClassOf(method, "com.bumptech.glide.Glide", true);
if (isMemberInClass || isMemberInSubClassOf) {
System.out.println("Glide2: "+node.getValueArguments().stream().count());
String obj = node.getValueArguments().get(0).asSourceString();
if (obj.toLowerCase().contains("application".toLowerCase())) { //檢驗 application
context.report(ISSUE, node, context.getLocation(node), "Glide.with盡量別傳入Application");
}
}
}
}
UCallExpression 中文表達式 如: Log.d("TAG","1111111")
PsiMethod 單純的指 Log.d()的方法
獲取參數的類型: method.getParameters()[0].getType()
獲取參數值: String obj = node.getValueArguments().get(0).asSourceString();
之后將GlideWithDetector 添加進.
public class LintRegistry extends IssueRegistry {
@NotNull
@Override
public List<Issue> getIssues() {
return Arrays.asList(
LogDetector.ISSUE,
GlideWithDetector.ISSUE,
);
}
}
既然lint 可以掃描。build.gradle 我是不是可以根據lint 來梳理 各個組件之間的依賴關系呢?參考了一些文章:https://juejin.cn/post/6963444269419872264#heading-8 發現的確是可行的。
5.實現module組件依賴關系可視化
自定義javaBean: TreeNode
public class TreeNode {
private String currentName;//當前module的名字
private List<TreeNode>chidrenNodes;//當前module下面的子module
public TreeNode(String currentName) {
this.currentName = currentName;
}
public TreeNode(String currentName, List<TreeNode> chidrenNodes) {
this.currentName = currentName;
this.chidrenNodes = chidrenNodes;
}
public String getCurrentName() {
return currentName;
}
public List<TreeNode> getChidrenNodes() {
return chidrenNodes;
}
}
DependencyDetector 代碼實現
public class DependencyDetector extends Detector implements Detector.GradleScanner { //繼承GradleScanner
private TreeNode mTreeNode;
public static final Issue ISSUE = Issue.create(
"dependeId",
"不需要提示",
"不需要提示",
Category.MESSAGES,
5,
Severity.WARNING,
new Implementation(DependencyDetector.class, EnumSet.of(Scope.GRADLE_FILE))
);
@Override
public void beforeCheckRootProject(@NotNull Context context) {
mTreeNode = getNodes(context.getMainProject());
super.beforeCheckRootProject(context);
stringBuffer=new StringBuffer();
printNode(mTreeNode);
System.out.println(stringBuffer.toString());
}
// 創建一個TreeNode 數據結構 遞歸填充個節點
public TreeNode getNodes(Project project) {
List<Project> projects = project.getDirectLibraries();//獲取子project,肯定是包括我們的依賴module
List<TreeNode> nodes = new ArrayList<>();
List<String> strings = new ArrayList<>();//存在多次掃描的情況
TreeNode mTreeNode = new TreeNode(project.getName(), nodes);
if (projects == null || projects.size() == 0) {
return mTreeNode;
}
for (int i = 0; i < projects.size(); i++) {
Project mProject = projects.get(i);
if (mProject.isGradleProject() && !strings.contains(mProject.getName())) {
nodes.add(getNodes(mProject));
strings.add(mProject.getName());
}
}
return mTreeNode;
}
StringBuffer stringBuffer;
//將組件組裝成,其中A,B 代表module名稱
// A-->B
// A-->c
// B-->D
// B-->C
public void printNode(TreeNode mTreeNode) {
for (int i = 0; i < mTreeNode.getChidrenNodes().size(); i++) {
TreeNode childTreeNode=mTreeNode.getChidrenNodes().get(i);
stringBuffer.append(""+mTreeNode.getCurrentName()+"-->"+childTreeNode.getCurrentName()+"\n");
printNode(childTreeNode);
}
}
}
然后在gradlew lint 將輸出的日志 copy出來:如 :
app-->module2
module2-->module5
app-->module3
app-->check
check-->module4
check-->module5
將此字符串復制這個字符串生成圖形 網站上。能快速展示出各個module之間的依賴關系。幫助新人快速理解項目
事件做到這步,基本上算完成了。
以上就是我對lint的學習。lint的玩法還有很多,等待各位去挖掘。