# gradle_plugin_android_aspectjx

**Repository Path**: chalet/gradle_plugin_android_aspectjx

## Basic Information

- **Project Name**: gradle_plugin_android_aspectjx
- **Description**: A Android gradle plugin that effects AspectJ on Android project and can hook methods in Kotlin, aar and jar file.
【转载】来自github wurensen的仓库
- **Primary Language**: Android
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2022-08-18
- **Last Updated**: 2023-11-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

AspectJX
===========

由于原作者不再维护，所以fork过来自己维护。

> [原作者说明文档](./README-old.md) 

## 最新版本（2.0.14）

[查看完整版本日志](CHANGELOG.md)

> 开发中的测试版本访问：[Sonatype's snapshot repository](https://s01.oss.sonatype.org/content/repositories/snapshots/io/github/wurensen/gradle-android-plugin-aspectjx/)

## 如何使用

* **插件引用**

在项目根目录的build.gradle里依赖**AspectJX**

```groovy
// Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
    repositories {
        // 已发布到mavenCentral仓库
        mavenCentral()
    }

    dependencies {
        // aspectj插件
        classpath 'io.github.wurensen:gradle-android-plugin-aspectjx:<version>'
    }
}
```

* **在app项目的build.gradle里应用插件**

```groovy
apply plugin: 'android-aspectjx'
//或者这样也可以
apply plugin: 'com.hujiang.android-aspectjx'
```

* **AspectJX配置**

**AspectJX**默认会处理所有的二进制代码文件和库，为了提升编译效率及规避部分第三方库出现的编译兼容性问题，**AspectJX**提供`include`、`exclude`命令来过滤需要处理的文件及排除某些文件(包括class文件及jar文件)。

**支持包名匹配**

```groovy
aspectjx {
    // 排除所有package路径中包含`android.support`的class文件及库（jar文件）
    exclude 'android.support'
}
```

> 注意事项1：规则的描述尽量用比较具体的范围，防止exclude的范围超出预期
> 注意事项2：注意apt编译期生成的类，比如项目的某个module模块用到glide注解生成类，生成的类会匹配上com.bumptech.glide导致整个module被过滤

**支持`*`和`**`匹配单独使用**

```groovy
aspectjx {
    // 忽略所有的class文件及jar文件，相当于AspectJX不生效
    exclude '*'
}
```

**提供enabled开关**

`enabled`默认为true，即默认**AspectJX**生效

```groovy
aspectjx {
    // 关闭AspectJX功能
    enabled false
}
```


## 适配情况

| 使用依赖 | 适配版本 |
| - | - |
| Android Gradle Plugin | 3.6.1（最低版本1.5） |
| Gradle | 6.3 |
| org.aspectj:aspectjtools | 1.9.6 |

> **AspectJX**是基于 gradle android插件1.5及以上版本设计使用的，如果你还在用1.3或者更低版本，请把版本升上去。


## 常见问题

* 问：**AspectJX**是否支持`*.aj`文件的编译?

答：不支持。目前**AspectJX**仅支持annotation的方式，具体可以参考[支持kotlin代码织入的AspectJ Demo](https://github.com/HujiangTechnology/AspectJ-Demo)

* 问：编译时会出现`can't determine superclass of missing type**`及其他编译错误怎么办？

答：大部分情况下把出现问题相关的class文件或者库（jar文件）过滤掉就可以搞定了

> 有任何问题可以提[Issues](https://github.com/wurensen/gradle_plugin_android_aspectjx/issues)或者[discussions](https://github.com/wurensen/gradle_plugin_android_aspectjx/discussions)

## License

```txt
Copyright 2021 LanceWu

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```