# java-obj-diff

**Repository Path**: zcm2018/java-obj-diff

## Basic Information

- **Project Name**: java-obj-diff
- **Description**: java比较对象差异工具类
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2024-06-14
- **Last Updated**: 2024-06-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# java-obj-diff
比较对象差异工具类。主要用于比较同一个类的两个对象属性值的差异。

此工具是建立在
```xml
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>3.12.0</version>
</dependency>
```
中的DiffBuilder基础上进行的重新开发和封装。
主要是解决一些bug.和加入了一些缓存提高比较时频繁反射的性能。同时增加了一些新特性。

### 特性
#### 属性忽略比较
##### 注解支持
使用 `@DiffIgnore` 注解可以忽略某个属性的比较。

```java
@DiffIgnore
private String name;
```

##### 手动忽略
调用工具类DiffUtil 时传递排除比较的字段名。

```java
DiffResult diffResult = DiffUtil.diff(obj1, obj2, "name");
```

#### 自定义比较器
使用 `@DiffCompare` 注解可以自定义某个属性的比较器。
自定义比较器需要实现 `DiffComparable` 接口。

```java
public class MyComparator implements DiffComparable {
    @Override
    public boolean diff(Object obj1, Object obj2) {
        return obj1.equals(obj2);
    }
}
```

使用自定义比较器
```java
@DiffCompare(using = MyComparator.class)
private String name;
```

#### 自定义类型属性
支持自定义成员变量需要使用注解标识。会自动解析到属性
可以加注解`@DiffBean`来标识。

```java
public class User {
    private String name;
    private int age;
    private Date birthday;
    @DiffBean
    private Address address;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public Date getBirthday() {
        return birthday;
    }
    
    public void setAddress(Address address) {
        this.address = address;
    }

    public Address getAddress() {
        return this.address;
    }
}
```

`@DiffBean`注解也支持加在 Collection及其子类上。并支持到Collection的元素类型为自定义类型
例如：
```java

 @DiffBean
private List<Packet> packetList;

@DiffBean
private List<Integer> friendIdList;
```

#### 别名支持
使用 `@DiffAlias` 注解可以自定义某个属性的别名。

```java
@DiffAlias(alias = "用户名")
private String name;
```
输出报告中会显示别名。否则默认使用字段属性名。

#### 格式化支持
使用 `@DiffFormat` 注解可以自定义某个属性的格式化。在输出结果中展示格式化后的数据。

```java
@DiffFormat(pattern = "yyyy-MM-dd", using=DateTimeDiffFormatter.class)
private Date birthday;
```

也可以自定义格式化器。需要实现接口:`com.openquartz.javaobjdiff.DiffFormatter`

例如：
```java
public class DateTimeDiffFormatter implements DiffFormatter {
    
    @Override
    public String format(Object obj) {
        
        if (StringUtils.isBlank(pattern)) {
            pattern = DEFAULT_FORMATTER_PATTERN;
        }

        if (Objects.isNull(value)) {
            return null;
        }

        if (value instanceof Date) {
            return DateFormatUtils.format((Date) value, pattern);
        }

        if (value instanceof TemporalAccessor) {
            return DateTimeFormatter.ofPattern(pattern).format((LocalDateTime) value);
        }

        throw new IllegalArgumentException("Unsupported type: " + value.getClass());
    }
}
```
使用场景：自定义类型、枚举类型等。可自己实现自定义格式化方式。

使用示例代码详见：`com.openquartz.javaobjdiff.test.DiffUtilTest`

#### 脱敏支持
使用注解可以支持对应的属性脱敏。\
`@EmailDataMask`可以支持邮箱脱敏。\
`@IdCardDataMask`可以支持身份证号脱敏。\
`@MobileDataMask`可以支持手机号脱敏。