一、介绍
1、key-value配对
当我们在需要返回两种值的情况下可以使用这个api,在核心Java库中可以使用配对(Pair)的实现、Apache Commons。如果原来的项目中jdk低于1.8建议使用Apache Commons这种方法,这样不用动原项目的jdk。
2、依赖
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.7</version>
</dependency>
3、使用
在Apache Commons库中,org.apache.commons.lang3.tuple 包中提供Pair抽象类,不能被直接实例化,可以通过Pair.of(L,R)实例化,提供了getLeft()和getRight()方法。
public class RedisTest {
public static void main(String[] args) {
try {
//不可变配对
Pair<String, String> pair = new ImmutablePair<>("123", "456");
//可变配对
Pair<String, String> pairV2 = new MutablePair<>("123", "456");
//不可变配对set值会抛错
//pair.setValue("123");
pairV2.setValue("123");
System.out.println(pair.getKey());
System.out.println(pair.getValue());
System.out.println(pair.getLeft());
System.out.println(pair.getRight());
System.out.println("-----------");
System.out.println(pairV2.getKey());
System.out.println(pairV2.getValue());
System.out.println(pairV2.getLeft());
System.out.println(pairV2.getRight());
} catch (Exception e) {
e.printStackTrace();
}
}
}
二、使用场景
接口需要返回两个值,又不想使用Map
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.tuple.Pair;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
@SpringBootTest(classes = {Application.class}, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@RunWith(SpringRunner.class)
@Slf4j
public class PairTest {
@Test
public void testPair() {
//包装类型
Pair<Boolean, Integer> numPair = isNumberVaild(-1);
log.info("左边={},右边={}", numPair.getLeft(), numPair.getRight());
numPair = isNumberVaild(2);
log.info("左边={},右边={}", numPair.getLeft(), numPair.getRight());
//对象
Pair<Integer, UserDTO> userPair = getUser("张三");
log.info("左边={},右边={}", userPair.getLeft(), userPair.getRight());
}
private Pair<Integer, UserDTO> getUser(String name) {
UserDTO userDTO = UserDTO.builder().userName(name).build();
return Pair.of(1,userDTO);
}
private Pair<Boolean, Integer> isNumberVaild(Integer number) {
if(number < 0){
return Pair.of(false, null);
}
return Pair.of(true, number*10);
}
}