# axe

**Repository Path**: CaiDongyu/axe

## Basic Information

- **Project Name**: axe
- **Description**: Java 后端框架，类似Spring 、Strus等（这样说比较好理解，原谅我并非有意抬高自己）。
特点：小，依赖少，启动快，Restful上手简单，特性和工具挺多
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: axe微核
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-03-11
- **Last Updated**: 2024-11-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

###添加Maven 依赖
```XML
<!-- axe web dependency -->
<dependency>
	<groupId>org.axe</groupId>
    <artifactId>axe</artifactId>
	<version>22.1.6-SNAPSHOT</version>
</dependency>
<dependency>
	<groupId>org.axe</groupId>
	<artifactId>mysql4axe</artifactId>
    <version>22.1.6-SNAPSHOT</version>
</dependency>
<dependency>
    <groupId>org.axe</groupId>
    <artifactId>axe-start-web</artifactId>
	<version>21.6.24-SNAPSHOT</version>
</dependency>
```

###添加配置文件 axe.jison
```JSON
#这是一份完整配置，可以使用最小配置，有需要再来这里复制参数
axe:{
	#非必选，使用无参启动时默认此参数指定端口，也可以手动指定启动端口，此时此参数无效
	port:8080
	#非必选，如果有ssl配置，则自动转为https服务，目前支持PKCS12类型的ssl文件
	sslKeyPath:
	#非必选，搭配ssl密钥文件
	sslPassword:
	#非必选，默认是true，打开此选项可以访问/axe来进入接口调试页面，生产环境谨慎开启
	home:false
	#非必选，默认是空，搭配home参数使用，如果home:true，此参数用于设置访问接口调试页面/axe的登录密码
	pass:1234
	#非必选，默认空字符串，比如填写acb，则原本访问请求需变成http://xxx.xxxx.xxx:port/abc/xxxxx
	application-name:
	#必选，指定扫描包路径，如果有多个用英文逗号分隔
	base-package:com.test
	#非必选，从base-package指定的扫描路径里排除一部分路径，如果有多个可以使用英文逗号分隔
	base-package-exclude:
	#非必选，指定上传文件的配置
	upload:{
		#非必选，限制上传文件的单次大小，单位M，默认不限制
		limit:
		#非必选，如果不填此参数，默认不支持文件上传
		tempdir:
	}
	#非必选，指定jsp页面的相对路径，建议填写/WEB-INF/view/下，不用jsp了就不需要再关心这个参数
	jsp-path:/WEB-INF/view/
	#非必选，搭配jsp-path使用的，也是Servlet指定静态文件相对路径用的，建议填写/WEB-INF/asset/下，不用jsp了就不需要再关心这个参数
	asset-path:/WEB-INF/asset/
	#非必选，指定html的包路径，默认空，如有多个以英文逗号分隔
	html:{
		#包路径
		path:
		#是否动态加载，默认false，开发环境建议true，可以省区添加删除文件时需要重启应用，生产环境可以关闭
		hard:false
	}
	#非必选，引入其他配置文件
	include:axe-local.jison
	#非必选，邮箱信息
	email:{
		#必选，是初始化axe邮箱客户端，默认false，如果打开，下面的配置才生效
		enable:false
		#默认非必选，如果enable:true，则必选
		server:{
			#邮箱host地址
			host:
			#邮箱host端口
			port:
			#是否启用ssl
			ssl:
			#邮箱host的用户名，就是邮箱地址
			username:
			#邮箱host的密码
			password:
		}
		#非必选，发件人，默认跟server.username一样
		from:
		#非必选，这里指定默认的邮件抬头，除了配置文件里以外，也可以在代码里运行时再修改
		title:
	}
	#非必填，打开参数请求回放request param replay，默认false关闭
	rpreplay:true
}

#最小配置
axe:{
	#非必选，使用无参启动时默认此参数指定端口，也可以手动指定启动端口，此时此参数无效
	port:8080
	#非必选，默认是true，打开此选项可以访问/axe来进入接口调试页面，生产环境谨慎开启
	home:true
	#必选，指定扫描包路径，多个用英文逗号分隔
	base-package:test
}
```

###写一个启动类
```java
import org.axe.jetty.AxeStartWeb;
import org.axe.jetty.config.JettyConfig;
import org.axe.util.LogUtil;

public class Application {
	public static void main(String[] args) {
		try {
			AxeProperties.loadArgs(args);
			MysqlHelper.config();
			JettyConfig config = new JettyConfig();
			AxeStartWeb.startServer(config);
		} catch (Exception e) {
			LogUtil.error(e);
		}
	}
}
```