# relationship

**Repository Path**: firfe/relationship

## Basic Information

- **Project Name**: relationship
- **Description**: 中国亲戚关系计算器
官网 https://passer-by.com/relationship
原项目 https://github.com/mumuy/relationship
我的镜像构建仓库
GitHub仓库 https://github.com/Firfr/relationship
Gitee仓库 https://gitee.com/firfe/relationship
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-17
- **Last Updated**: 2025-09-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://travis-ci.org/mumuy/relationship.svg?branch=gh-pages)](https://travis-ci.org/mumuy/relationship/)

由于工作生活节奏不同，如今很多关系稍疏远的亲戚之间来往并不多。因此放假回家过年时，往往会搞不清楚哪位亲戚应该喊什么称呼，很是尴尬。然而搞不清亲戚关系和亲戚称谓的不仅是小孩，就连年轻一代的大人也都常常模糊混乱。

“中国家庭称谓计算器”为你避免了这种尴尬，只需简单的输入即可算出称谓。输入框兼容了不同的叫法，你可以称呼父亲为：“老爸”、“爹地”、“老爷子”等等，方便不同地域的习惯叫法。快捷输入按键，只需简单的点击即可完成关系输入，算法还支持逆向查找称呼哦～！


项目演示地址：[https://passer-by.com/relationship/](https://passer-by.com/relationship/)

移动版演示地址: [https://passer-by.com/relationship/vue/](https://passer-by.com/relationship/vue/)

## 镜像制作

当前制作镜像版本(或截止更新日期)：1.2.0

- 原项目地址
  - 官网 [https://passer-by.com/relationship/](https://passer-by.com/relationship/)
	- 移动版演示地址: [https://passer-by.com/relationship/vue/](https://passer-by.com/relationship/vue/)
  - GitHub仓库 https://github.com/mumuy/relationship
- 我构建docker镜像的仓库
  - GitHub仓库 https://github.com/Firfr/relationship
  - Gitee仓库 https://gitee.com/firfe/relationship

欢迎关注我B站账号 [秦曱凧](https://space.bilibili.com/17547201) (读作 qín yuē zhēng)  

有需要帮忙部署这个项目的朋友,一杯奶茶,即可程远程帮你部署，需要可联系。  
微信号 `E-0_0-`  
闲鱼搜索用户 `明月人间`  
或者邮箱 `firfe163@163.com`  
如果这个项目有帮到你。欢迎start。

有其他的项目的汉化需求，欢迎提issue。或其他方式联系通知。

### 镜像

从阿里云或华为云镜像仓库拉取镜像，注意填写镜像标签，镜像仓库中没有`latest`标签

容器内部端口`5147`，可通过设置启动参数的值来指定监听端口。

```bash
swr.cn-north-4.myhuaweicloud.com/firfe/relationship:1.2.0
```

### docker run 命令部署

```bash
docker run -d \
--name relationship \
--network bridge \
--restart always \
--log-opt max-size=1m \
--log-opt max-file=1 \
-p 5147:5147 \
swr.cn-north-4.myhuaweicloud.com/firfe/relationship:1.2.0
```
在命令最后追加`-p 端口`自定义端口

### compose 文件部署 👍推荐

```yaml
#version: '3'
name: relationship
services:
  relationship:
    container_name: relationship
    image: swr.cn-north-4.myhuaweicloud.com/firfe/relationship:1.2.0
    network_mode: bridge
    restart: always
    logging:
      options:
        max-size: 1m
        max-file: '1'
    ports:
      - 5147:5147
    # 指定端口
    # command: ["-p", "自定义端口"] 
```

### 修改说明

这里对除了汉化之外的代码修改的说明。  
增加修改部分具体见 [修改说明](./修改说明.md)。

`./README.md` 文件翻译，增加 `## 汉化&修改`

增加目录 `./图片` `./remote_files`(引用的远程文件)
新增文件 `./.dockerignore`、`./Dockerfile`、`./翻译说明.md`、`./修改说明.md`、`./本地调试命令记录.md` 

### 效果截图

| ![简体](图片/简体.png) | ![繁体](图片/繁体.png) | ![手机版](图片/手机版.png) |
|-|-|-|


## 一、下载 & 安装

该 Javascript 库 / 模块可以用于前端也可以用于后端 Nodejs 中。

1. 直接下载dist/relationship.min.js，然后使用 `<script>`标签引入，可以得到全局的方法 `relationship`.
2. 使用 npm 进行包管理，具体为：

	> **npm install relationship.js**

然后使用 `require` 引入模块

```js
var relationship = require("relationship.js");
```


## 二、使用
1. 通用方法: 唯一的计算方法 `relationship(options)`.

参数`options`结构为：

```js
var options = {
	text:'',		// 目标对象：目标对象的称谓汉字表达，称谓间用‘的’字分隔
	target:'',	    	// 相对对象：相对对象的称谓汉字表达，称谓间用‘的’字分隔，空表示自己
	sex:-1,			// 本人性别：0表示女性,1表示男性
	type:'default',		// 转换类型：'default'计算称谓,'chain'计算关系链,'pair'计算关系合称
	reverse:false,		// 称呼方式：true对方称呼我,false我称呼对方
	mode:'default',		// 模式选择：使用setMode方法定制不同地区模式，在此选择自定义模式
	optimal:false,       	// 最短关系：计算两者之间的最短关系
};
```

代码示例：

```js
// 如：我应该叫外婆的哥哥什么？
relationship({text:'妈妈的妈妈的哥哥'});
// => ['舅外公']

// 如：七舅姥爷应该叫我什么？
relationship({text:'七舅姥爷',reverse:true,sex:1});
// => ['甥外孙']

// 如：舅公和我具体是什么关系？
relationship({text:'舅公',type:'chain'});
// => ['爸爸的妈妈的兄弟', '妈妈的妈妈的兄弟', '老公的妈妈的兄弟']

// 如：舅妈如何称呼外婆？
relationship({text:'外婆',target:'舅妈',sex:1});
// => ['婆婆']

// 如：外婆和奶奶之间是什么关系？
relationship({text:'外婆',target:'奶奶',type:'pair'});
// => ['儿女亲家']

```
2. 内部属性：获取当前数据表 `relationship.data`.

3. 内部属性：获取当前数据量 `relationship.dataCount`.

4. 内部方法：用户自定义模式 `relationship.setMode(mode_name,mode_data)`.

代码示例(可参考数据表格式对数据进行覆盖)：

```js
// 关系解析语法
// 【关系链】f:父,m:母,h:夫,w:妻,s:子,d:女,xb:兄弟,ob:兄,lb:弟,xs:姐妹,os:姐,ls:妹
// 【修饰符】 1:男性,0:女性,&o:年长,&l:年幼,#:隔断,[a|b]:并列
relationship.setMode('northern',{
	'm,f':['姥爷'],
	'm,m':['姥姥'],
	'm,xb,s&o':['表哥'],
	'm,xb,s&l':['表弟'],
});
```

## 三、开发 & 贡献

```sh
# 安装开发依赖
npm install

# build 模块: 将 relationship 打包压缩
npm run build

# 执行测试用例（可以在tests/test.js中完善测试用例）
npm test
```


## 四、关于分歧

一些称呼存在南北方或地区差异，容易引起歧义，并不保证和你所处地区的称谓习惯一致。

部分称呼有多种关系且跨辈分。例如：
* 大爷：爷爷的哥哥 / 父亲的哥哥(北方)；
* 舅公：爸妈的舅舅 / 老公的舅舅；
* 伯公：爸妈的伯父 / 老公的伯父；
* 叔公：爸妈的叔叔 / 老公的叔叔；
* 姨公：爸妈的姨丈 / 老公的姨丈；
* 姨夫：姨妈的老公 / 姨子的老公；
* 姑夫：姑妈的老公 / 姑子的老公；
* 婶子：叔叔的老婆 / 叔子的老婆；
* 妗子：舅舅的老婆 / 舅子的老婆；

部分称呼以现代生活常见理解为主。例如：
* 媳妇：在古代或者北方地区指儿子的妻子，这里指自己的妻子(儿媳妇写作“息妇”)；
* 太太：一些地方指年长的妇人或曾祖父母，这里指自己的妻子；

## 五、教程

* [算法实现原理](https://github.com/mumuy/relationship/wiki/%E7%AE%97%E6%B3%95%E5%AE%9E%E7%8E%B0)

## 六、其他

他们都在用：

查询网
http://www.ip138.com/chengwei/

在线查询网
http://qinshu.supfree.net/

在线工具
http://www.atool.org/relateship.php

有道语文达人
http://dict.youdao.com/k12yuwen/html/relation.html

小米MIUI系统计算器
http://www.miui.com/

小米MIUI网页版本
http://www.miui.com/zt/calculator2016/dist.php

符号库
http://www.fuhaoku.com/tool/qinqiguanxi.html