# hero_story

**Repository Path**: yangcode/hero_story

## Basic Information

- **Project Name**: hero_story
- **Description**: 英雄传说，用于学习 
后端：netty+websocket+protobuf
前端：Cocos Creator+ts+其他一些工具(角色动作、形态构建等)
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2023-09-11
- **Last Updated**: 2023-09-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# HERO_STORY
<div align="center">
    <img alt="英雄传说" src="https://img.shields.io/badge/英雄-传说-red.svg">
    <h2 align="center"><b>英雄传说</b></h2>
</div>
<div align="center">
<h3 align="center">一个普普通通的游戏后端项目</h3>
</div>
<br/>
<p align="center">
    <a target="_blank" href="https://gitee.com/ashscc/hero_story/blob/master/LICENSE">
        <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?label=license" />
    </a>
    <a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html">
        <img src="https://img.shields.io/badge/JDK-11-green.svg" />
    </a>
    <a target="_blank" href="https://www.jetbrains.com/idea/download/#section=mac">
        <img src="https://img.shields.io/badge/tool-idea-yellow.svg"/>
    </a>
    <a target="_blank" href="https://www.jetbrains.com/idea/download/#section=mac">
        <img src="https://img.shields.io/badge/version-v1.0.0-pink.svg"/>
    </a>
</p>

### 🚩 一、项目介绍

英雄传说 是一个学习过程项目，主要是为了整合学习过程中的各种工具，逼迫自己使用它们把项目的整个生命周期串起来。包含了`log4j2`,日志打印格式；`checkStyle`代码编码风格校验；
`netty`NIO相关知识；`docker` + `Jenkins` 体验容器套娃的"酸爽"(不推荐这么用)；`protoBuffer`另一种传输格式；`Ansible` + `Ansible-playbook`批量控制机器部署啥的;
学习过程中有一部分文档输出放到了 [博客园](https://www.cnblogs.com/ashScc/) ，还有一部分写的不太好放到了自己的`logSeq`上，就不贴了。与君共勉👊👊👊

##### 🏅开源地址
[![Gitee](https://img.shields.io/badge/Gitee-https://gitee.com/ashscc/hero_story.git-green)](https://gitee.com/ashscc/hero_story.git)  <br/>

### 🍀 二、使用到的中间件
- ✅ MySQL
- ✅ Redis
- - [x] caffeine
- - [ ] rocketMQ

### 🌰 三、代码检查工具`checkStyle`

使用的是apache开源的`checkStyle`, [如何使用](https://maven.apache.org/plugins/maven-checkstyle-plugin/index.html) 这款工具规范自己的代码
风格和日常习惯，点击查看官网使用文档。[参数详解](https://checkstyle.org/index.html) 查看官方文档即可。

### 🍎 四、`redis`需要熟悉一下`zset`的使用

`zset`即`sorted set`，一般用于Rank排名，具体用法可以网上搜一下，这里提供一些简单的用法
```bash
## 操作map的两个操作: hset、hget
## 原子加操作：hincryby
eg.
hset user_1 BasicInfo "{userId:1}"
hset user_1 Win 1
hget user_1 Win
hincryby user_1 Win 1
hget user_1 Win

操作sorted set操作：zadd、zrange、zrevrange
zadd Rank 1 2
zadd Rank 2 1
zrange Rank 0 9
zrange Rank 0 9 withscores
zrevrange Rank 0 9 withscores
```
### 🍐 五、`mysql`表就一张
```roomsql
-- t_user 
CREATE TABLE `t_user` (
  `id` int NOT NULL AUTO_INCREMENT,
  `user_name` varchar(45) COLLATE utf8mb4_bin DEFAULT NULL,
  `password` varchar(45) COLLATE utf8mb4_bin DEFAULT NULL,
  `hero_avatar` varchar(45) COLLATE utf8mb4_bin DEFAULT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `id_UNIQUE` (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;
```