# 新兵作战指南（后端篇）

## 目录

- [新兵作战指南（后端篇）](#%E6%96%B0%E5%85%B5%E4%BD%9C%E6%88%98%E6%8C%87%E5%8D%97%E5%90%8E%E7%AB%AF%E7%AF%87)
  - [武器准备（ENV）](#%E6%AD%A6%E5%99%A8%E5%87%86%E5%A4%87env)
    - [JDK](#jdk)
    - [IDE](#ide)
    - [DB](#db)
    - [VCS](#vcs)
  - [配件准备（plugin）](#%E9%85%8D%E4%BB%B6%E5%87%86%E5%A4%87plugin)
    - [必要插件](#%E5%BF%85%E8%A6%81%E6%8F%92%E4%BB%B6)
      - [lombok](#lombok)
      - [checkstyle](#checkstyle)
      - [MyBatisX](#mybatisx)
    - [推荐插件](#%E6%8E%A8%E8%8D%90%E6%8F%92%E4%BB%B6)
      - [RestfulTool](#restfultool)
      - [Maven Helper](#maven-helper)
      - [Smart Tomcat](#smart-tomcat)
      - [SequenceDiagram](#sequencediagram)
  - [军规（规范）](#%E5%86%9B%E8%A7%84%E8%A7%84%E8%8C%83)
    - [代码规范](#%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83)
    - [注释规范](#%E6%B3%A8%E9%87%8A%E8%A7%84%E8%8C%83)
  - [常见问题](#%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## 武器准备（ENV）

### JDK

目前公司JDK使用的是1.8版本的JDK。你可以选择使用oracleJDK，也可以使用其他OpenJDK，如：[adoptium](https://adoptium.net/releases.html?variant=openjdk8)

### IDE

目前公司不限制你使用什么IDE。你可以选择使用Eclipse，IDEA，甚至是VSCODE。但要注意的是Eclipse默认情况下，创建的文本是GBK格式，IDEA默认使用的是UTF-8。在开发前，需要注意修改IDE的默认编码，避免发生文件需要重新转换编码的尴尬。在IDE的选用上，笔者推荐使用IDEA社区版。

### DB

目前，公司大部分项目均使用[PostgreSQL（简称PG）](https://www.postgresql.org/)作为业务支撑。如非分派的项目组的项目不使用PG，请提前下载12或以上版本的PG。

### VCS

目前公司已全面使用本平台（Gitea）进行版本控制。因此，请读者准备好以下两件套：  

- [git](https://git-scm.com/)
- [TortoiseGit](https://tortoisegit.org/download/)（git乌龟，可选用其他可视化工具）

## 配件准备（plugin）

插件主要都是在IDEA下的。

### 必要插件

#### lombok

用于生成实体getter，setter等方法的插件。IDEA直接在插件市场即可安装。如果是Eclipse，需要下载对应jar包后，使用管理员身份的命令行运行jar包进行安装。

#### checkstyle

公司2021年中旬后开始，开始限制代码规范风格。具体配置请下载同目录下的[checkstyle.xml](checkstyle.xml)文件。

#### MyBatisX

这是IDEA下的插件。公司的项目都是用了Mybatis，下载这个插件能方便开发。

### 推荐插件

#### RestfulTool

一个spring mvc下的快速接口查找插件。

#### Maven Helper

maven助手

#### Smart Tomcat

IDEA社区版运行tomcat必装

#### SequenceDiagram

代码调用时序图生成器，方便快速查看方法的所有调用链路。

## 军规（规范）

### 代码规范

### 注释规范

[Java文档注释规范倡议](Java文档注释规范倡议.md)

## 常见问题