README.md · sd4324530/JTuple

# JTuple

[![@peiyu on weibo](https://img.shields.io/badge/weibo-%40peiyu-red.svg)](http://weibo.com/1728407960)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.sd4324530/JTuple/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.sd4324530/JTuple)
[![JDK 1.8](https://img.shields.io/badge/JDK-1.8-green.svg "JDK 1.8")]()
[![Circle CI](https://circleci.com/gh/sd4324530/JTuple/tree/master.svg?style=svg)](https://circleci.com/gh/sd4324530/JTuple/tree/master)
[![codecov](https://codecov.io/gh/sd4324530/JTuple/branch/master/graph/badge.svg)](https://codecov.io/gh/sd4324530/JTuple)
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)

java语言版本的`元组`数据类型，实现了元组类型的特性（`不可变`、 `可迭代`）以及常用操作方法

**轻量级，无依赖，线程安全**

##  元组的意义

**元组最重要的意义是用来实现多值返现。** 很多时候我们需要返回一组值，更可怕的是这组值的类型可能并不完全一样，比如http请求时，有请求的返回码（int）以及响应报文（String）

对于java人员来说，遇到这种情况时，一般的解决方案是编写一个类，类里只有2个属性，分别是以上2个，然后返回给调用者。是不是有种胸闷的感觉。折腾，造孽啊

或者就返回一个列表，但是因为类型不统一，只能用`List<Object>`，后续处理的代码的可读性会很差，我相信任何一个技术水平过关或者有职业操守的程序员都不会这么做

元组的出现，就是为了解决这种情况的，很多年轻的语言（`Python`, `Scala`...）都内置了元组，本项目就是让Java开发人员也可以享受到元组带来的编程时的便捷和快乐

## 主要实现

## 元组操作

## API使用样例
```java
//静态导入工具类，然后开始优雅的使用元组吧
import static com.github.sd4324530.jtuple.Tuples.tuple;
```

```java
//读取指定位置元素
Tuple2<String, Integer> tuple = tuple("test", 123);
log.debug("first:{}", tuple2.first);//test
log.debug("second:{}", tuple2.second);//123
```

``` java
//toString
Tuple4<String, Integer, Boolean, Double> tuple = tuple("test", 123, true, 186.5);
log.debug("tuple4:{}", tuple.toString());//(test, 123, true, 186.5)
```

``` java
//元组遍历
Tuple5<String, Integer, Boolean, Double, Character> tuple = tuple("test", 123, true, 186.5, 'A');
//方式1
tuple.forEach(o -> log.debug(Objects.toString(o)));
//方式2
for (Object object : tuple) {
  log.debug(Objects.toString(object));
}
```

```java
//元组合并
Tuple1<String> tuple1 = tuple("hello");
Tuple2<String, String> tuple2 = tuple("world", "!");
Tuple3<Integer, Integer, Integer> tuple3 = tuple(1, 2, 3);
log.debug("add:{}", tuple1.add(tuple2).toString());//(hello, world, !)
log.debug("add:{}", tuple1.add(tuple2, tuple3).toString());//(hello, world, !, 1, 2, 3)
```

```java
//元组翻转
Tuple4<String, Integer, Boolean, Double> tuple = tuple("hello", 123, true, 186.5);
log.debug("reverse:{}", tuple.reverse().toString());//(186.5, true, 123, hello)
```

```java
//元组重复
Tuple2<String, String> tuple2 = tuple("a", "b");
log.debug("repeat:{}", tuple2.repeat(3).toString());//(a, b, a, b, a, b)
```

``` java
//截取子元组
TupleN tupleN = tuple(0, 1, 2, 3, 4, 5, 6);
log.debug("sub:{}", tupleN.subTuple(0, 3).toString());//(0, 1, 2, 3)
```

```java
//转换成流
Tuple5<String, Integer, Boolean, Object, Double> tuple5 = tuple("hello", 123, true, null, 186.5);
tuple5.stream().forEach(o -> log.debug("元素:{}", o));
```

```java
//元组列表排序
//静态导入工具类
import static com.github.sd4324530.jtuple.Tuples.tuple;
import static com.github.sd4324530.jtuple.Tuples.sort;

List<Tuple2> list = new ArrayList<>();
list.add(tuple(5, "5"));
list.add(tuple(2, "2"));
list.add(tuple(3, "3"));
list.add(tuple(1, "1"));
list.add(tuple(4, "4"));
log.debug("before:{}", list);
//按第一列Integer类型升序
sort(list, 0, Integer::compare);
log.debug("after:{}", list);//1, 2, 3, 4, 5
```

```java
//元组数组排序
//静态导入工具类
import static com.github.sd4324530.jtuple.Tuples.tuple;
import static com.github.sd4324530.jtuple.Tuples.sort;

Tuple2[] array = new Tuple2[5];
array[0] = tuple("5", 5);
array[1] = tuple("2", 2);
array[2] = tuple("3", 3);
array[3] = tuple("1", 1);
array[4] = tuple("4", 4);
log.debug("before:{}", Arrays.toString(array));
//按第一列String类型升序
sort(array, 0, String::compareTo);
log.debug("after:{}", Arrays.toString(array));
```

## 元组使用场景样例

1. http请求封装

```java
   public class HttpKit {

/**
        * http get 请求
        *
        * @param url 请求url
        * @return 请求结果元组，第一个元素为请求返回码，第二个参数为返回内容，第三个参数为请求失败时的异常
        */
       public Tuple3<Integer, String, Exception> get(String url) {
           //发送请求，解析结果
           return null;
       }
   }
   ```

2. 数据库操作封装

```java
   public class DbKit {

import static com.github.sd4324530.jtuple.Tuples.tuple;
       /**
        * 执行查询sql
        *
        * @param sql 查询sql
        * @return 执行结果元组，第一个元素用来判断执行是否出现异常，如果为null，则表示成功；第二个参数为查询结果
        */
       public Tuple2<Exception, List<Object>> query(String sql) {
           try (Connection connection = getConn(); Statement statement = connection.createStatement(); ResultSet resultSet = statement.executeQuery(sql)) {
               List<Object> data = handleResult(resultSet);
               return tuple(null, data);
           } catch (Exception e) {
               return tuple(e, null);
           }
       }
   }
   ```

## 引入(jdk >= 1.8)

```xml
<dependency>
     <groupId>com.github.sd4324530</groupId>
     <artifactId>JTuple</artifactId>
     <version>1.2.1</version>
</dependency>
```

sd4324530/JTuple

简介

发行版

贡献者

近期动态

sd4324530/JTuple .gitee-modal { width: 500px !important; }

简介

发行版

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

sd4324530/JTuple