Code Monkey home page Code Monkey logo

server-guideline's Introduction

Macchinetta Server Framework (1.x) Development Guideline

This guideline provides best practices to develop highly maintainable Web applications using full stack framework focussing on Spring Framework, Spring MVC, Spring Security and MyBatis.

This guideline helps to proceed with the software development (mainly coding) smoothly.

Source files

Source files of this guideline are stored into following directories.

  • Japanese version : {repository root}/source/

Source file format

This guideline is written by the reStructuredText format(.rst). About the reStructuredText format, refer to the Sphinx documentation contents.

How to build

We build to HTML and PDF files using the Sphinx. About the Sphinx, refer to the Sphinx documentation contents.

Install the Sphinx

Please install the Python and Sphinx.

Note: Creating PDF file

If create a PDF file, LaTeX environment is required.

Clone a repository

Please clone a Macchinetta/server-guideline-thymeleaf repository or forked your repository.

git clone https://github.com/Macchinetta/server-guideline-thymeleaf.git

or

git clone https://github.com/{your account}/server-guideline-thymeleaf.git

Build HTML files

Please execute the build-html.sh or build-html.bat. If build is successful, HTML files generate to the {your repository}/build/html/ directory.

Linux or Mac:

$ cd {your repository directory}
$ ./build-html.sh

Windows:

> cd {your repository directory}
> build-html.bat

Build a PDF file

Please execute the build-pdf.sh. If build is successful, PDF file(MacchinettaServerFrameworkDevelopmentGuideline.pdf) generate to the {your repository}/build/latex/ directory.

$ cd {your repository directory}
$ ./build-pdf.sh

Terms of use

Terms of use refer to here.

server-guideline's People

Contributors

macchinetta-fw avatar nota-ja avatar tiwatsuka avatar yuta-koizumi avatar dobashi avatar

Stargazers

mcamcalin avatar otokunaga avatar aki-s avatar kannkyo avatar NeriUdon avatar makoto kinoshita avatar Toshio Hashizume avatar  avatar

Watchers

James Cloos avatar Yoshikazu Nojima avatar  avatar Toshio Hashizume avatar

server-guideline's Issues

ActiveMQがMacchinettaガイドラインの記載通りに動作しない

説明

Spring Framewrok 5からJMSのAPIのバージョンは2.0が要求されていますが、Macchinettaオンライン版開発ガイドラインの8.2.3.1.1. Apache ActiveMQを利用する場合で説明されている通りに設定すると、Apache ActiveMQ 5が使用され、これのJMSのAPIのバージョンは1.1であるため、正常に動作しないことが確認されています。

対応方針

クラスパスにJMS 2.0のライブラリ(javax.jms-api-2.0.1.jar)を追加することで、動作することを確認しています。但し、本対応は暫定対処であり、本格対処としてはJMS 2.0に対応しているActiveMQ Artemisへの対応を検討しています。Macchinetta 1.6.1.RELEASEの現時点では、ActiveMQ Artemisでの動作確認は実施できておりません。

影響バージョン

Macchinetta Server Framework 1.6.1.RELEASE 開発ガイドライン(JSP版)
Macchinetta Server Framework 1.6.1.RELEASE 開発ガイドライン(Thymeleaf版)

Compile error on parsing a string to java.time.LocalTime

Description

The following sample code is wrong.

Chapter: アプリケーション形態に依存しない汎用機能
Section: 7.3. 日付操作(JSR-310 Date and Time API)
Location: 7.3.2.3.6. 文字列からのパース

LocalTime localTime = LocalDate.parse("14:09:20", formatter2);

Type is mismatched.

Possible Solutions

Should change LocalDate.parse to LocalTime.parse.

LocalTime localTime = LocalTime.parse("14:09:20", formatter2);

Affects Version/s

  • All versions

Fix Version/s

(To be written later by project member)

Issue Links

「4.2.3.2.1. ビジネス例外を発生させる」のプロパティの設定とアプリケーションログの出力例について

Description

プロパティに設定した値を使用して可変文言をアプリケーションログに出力しているようには見えないが、参考としてエラーコードのプロパティの設定ファイルの内容を画面キャプチャを掲載している。理由がわからない。
出力例と関係ない情報は混乱する。

image

Possible Solutions

Affects Version/s

  • 1.9.1.RELEASE

Fix Version/s

Issue Links

Datasources bean names are different between guideline's and blank projects'.

Description

In section 6.1.2.3.1. log4jdbc提供のデータソースの設定, datasource's bean name is set dataSourceSpied.
On the other hand, in multi blank project and single's -env.xml, datasource's bean name is set realDataSource.

If there is no particular reason, same names should be set.

Possible Solutions

I think realDataSource is easier to understand than dataSourceSpied.

Affects Version/s

  • 1.X.X.RELEASE

Fix Version/s

(To be written later by project member)

Issue Links

  • #XXX

Improve the explanation about JCE Policy files on Encryption Chapter

Description

I will propose to consider improving the explanation about JCE Policy files because it includes since JDK/JRE 7u161 and 8u151. Further more, default policy change to unlimited from limited since JDK/JRE 7u171 and 8u161.

Possible Solutions

(Please write ideas or candidates of solutions for the problem if you have)

Affects Version/s

  • 1.X.X.RELEASE

Fix Version/s

(To be written later by project member)

Issue Links

Nothing

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.