参考的文档的位置:
1. http://xitrum-framework.github.io/guide/3.28/html/en/ (需要选择合适的版本,我选的是3.28,目前没有中文版)
可以选择Download PDF,下载英文Guide xitrum-en.pdf
2. API ScalaDocs:
http://xitrum-framework.github.io/api.html 选择3.27即可
注意:在国内访问Xitrum官网实在是慢得要死,还请自备FQ软件
开始自己构建Xitrum项目:
1. 创建一个空的Xitrum项目,需要下载 xitrum-new.zip
wget -O xitrum-new.zip https://github.com/xitrum-framework/xitrum-new/archive/master.zip
或
curl -L -o xitrum-new.zip https://github.com/xitrum-framework/xitrum-new/archive/master.zip
和xitrum相关的代码放在 https://github.com/xitrum-framework/ 中
2. 解压 xitrum-new.zip,进入 解压缩后的路径 xitrum-new/,运行 sbt/sbt run
此sbt命令,会下载Xitrum所有依赖的jar包,编译项目,运行 quickstart.Boot类,启动web server
浏览器打开 http://localhost:8000/ 或 https://localhost:4430/ 可以进入主页面
3. 把空的 Xitrum 项目导入到 Eclipse中
1)在目录xitrum-new中,运行 sbt/sbt eclipse,会生成了 .project 和 .class 等项目文件
2)打开build.sbt文件,查看所需的scala和java版本
p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 10.0px Helvetica }
scalaVersion := "2.12.1"
p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 10.0px Helvetica }
span.s1 { text-decoration: underline }
// Xitrum requires Java 8
javacOptions ++= Seq("-source", "1.8", "-target", "1.8")
3)配置Eclipse Scala IDE,
在Windows->Preference下,Scala > Installations, Add 2.12.0的Scala版本(用2.12.1会使3.28.3的Xitrum中的一个jar报错)
在Java配置项下,确认使用的是Java8
然后可以用 eclipse 打开此项目,在 项目Properties > Scala Compiler > Scala Installation中,选择2.12.0的版本,点OK
4)运行quickstart.Boot
如果没有Boot类的运行条目,则在 Run Configuration > Scala中添加一个即可,Main Class是quickstart.Boot
注意:最好先运行 sbt/sbt run,然后再运行 sbt/sbt eclipse,这样就可以在 Eclipse里运行 quickstart.Boot并启动web server和app了
如果在Eclipse中运行 只通过 sbt/sbt eclipse生成项目,会抛出错误,应该是因为Eclipse运行quickstart.Boot时,有一些必要的文件没有生成,
和运行sbt/sbt run后的文件路径相比就可以看出来。但我目前不知道如何在Eclipse中解决这个问题
5)最终的文件路径结构
其中,以下路径及其文件不属于源码,不必放到SVN或Git上,可以被忽略掉
log
project/project
project/target
target
tmp
4. Xitrum相关帮助文档的位置