Package structure for a Java project

Question

Whats the best practice for setting up package structures in a Java Web Application   How would you setup your src  unit test code  etc

User · Answer

One another way is to separate out the APIs  services  and entities into different packages

User · Answer

The way I usually organise is - src         - main                 - java                 - groovy                 - resources         - test                 - java                 - groovy - lib - build         - test                  - reports                 - classes - doc

User · Answer

I usually like to have the following    bin  Binaries  doc  Documents  inf  Information  lib  Libraries  res  Resources  src  Source  tst  Test    These may be considered unconventional  but I find it to be a very nice way to organize things

User · Answer

You could follow maven s standard project layout  You don t have to actually use maven  but it would make the transition easier in the future  if necessary   Plus  other developers will be used to seeing that layout  since many open source projects are layed out this way

User · Answer

There are a few existing resources you might check    Properly Package Your Java Classes Spring 2 5 Architecture Java Tutorial - Naming a Package SUN Naming Conventions   For what it s worth  my own personal guidelines that I tend to use are as follows    Start with reverse domain  e g   com mycompany   Use product name  e g   myproduct    In some cases I tend to have common packages that do not belong to a particular product   These would end up categorized according to the functionality of these common classes  e g   io    util    ui   etc  After this it becomes more free-form   Usually I group according to project  area of functionality  deployment  etc   For example I might have  project1    project2    ui    client   etc    A couple of other points    It s quite common in projects I ve worked on for package names to flow from the design documentation   Usually products are separated into areas of functionality or purpose already  Don t stress too much about pushing common functionality into higher packages right away   Wait for there to be a need across projects  products  etc   and then refactor  Watch inter-package dependencies   They re not all bad  but it can signify tight coupling between what might be separate units   There are tools that can help you keep track of this

User · Answer

You could follow maven s standard project layout  You don t have to actually use maven  but it would make the transition easier in the future  if necessary   Plus  other developers will be used to seeing that layout  since many open source projects are layed out this way

User · Answer

The way i usually have my hierarchy of folder-   Project Name   src bin tests libs  docs

User · Answer

The way i usually have my hierarchy of folder-   Project Name   src bin tests libs  docs

User · Answer

There are a few existing resources you might check    Properly Package Your Java Classes Spring 2 5 Architecture Java Tutorial - Naming a Package SUN Naming Conventions   For what it s worth  my own personal guidelines that I tend to use are as follows    Start with reverse domain  e g   com mycompany   Use product name  e g   myproduct    In some cases I tend to have common packages that do not belong to a particular product   These would end up categorized according to the functionality of these common classes  e g   io    util    ui   etc  After this it becomes more free-form   Usually I group according to project  area of functionality  deployment  etc   For example I might have  project1    project2    ui    client   etc    A couple of other points    It s quite common in projects I ve worked on for package names to flow from the design documentation   Usually products are separated into areas of functionality or purpose already  Don t stress too much about pushing common functionality into higher packages right away   Wait for there to be a need across projects  products  etc   and then refactor  Watch inter-package dependencies   They re not all bad  but it can signify tight coupling between what might be separate units   There are tools that can help you keep track of this

User · Answer

I usually like to have the following    bin  Binaries  doc  Documents  inf  Information  lib  Libraries  res  Resources  src  Source  tst  Test    These may be considered unconventional  but I find it to be a very nice way to organize things

User · Answer

The way i usually have my hierarchy of folder-   Project Name   src bin tests libs  docs

User · Answer

The way I usually organise is - src         - main                 - java                 - groovy                 - resources         - test                 - java                 - groovy - lib - build         - test                  - reports                 - classes - doc

User · Answer

You could follow maven s standard project layout  You don t have to actually use maven  but it would make the transition easier in the future  if necessary   Plus  other developers will be used to seeing that layout  since many open source projects are layed out this way

User · Answer

One another way is to separate out the APIs  services  and entities into different packages

User · Answer

I would suggest creating your package structure by feature  and not by the implementation layer  A good write up on this is Java practices  Package by feature  not layer

User · Answer

There are a few existing resources you might check    Properly Package Your Java Classes Spring 2 5 Architecture Java Tutorial - Naming a Package SUN Naming Conventions   For what it s worth  my own personal guidelines that I tend to use are as follows    Start with reverse domain  e g   com mycompany   Use product name  e g   myproduct    In some cases I tend to have common packages that do not belong to a particular product   These would end up categorized according to the functionality of these common classes  e g   io    util    ui   etc  After this it becomes more free-form   Usually I group according to project  area of functionality  deployment  etc   For example I might have  project1    project2    ui    client   etc    A couple of other points    It s quite common in projects I ve worked on for package names to flow from the design documentation   Usually products are separated into areas of functionality or purpose already  Don t stress too much about pushing common functionality into higher packages right away   Wait for there to be a need across projects  products  etc   and then refactor  Watch inter-package dependencies   They re not all bad  but it can signify tight coupling between what might be separate units   There are tools that can help you keep track of this

User · Answer

I would suggest creating your package structure by feature  and not by the implementation layer  A good write up on this is Java practices  Package by feature  not layer

User · Answer

There are a few existing resources you might check    Properly Package Your Java Classes Spring 2 5 Architecture Java Tutorial - Naming a Package SUN Naming Conventions   For what it s worth  my own personal guidelines that I tend to use are as follows    Start with reverse domain  e g   com mycompany   Use product name  e g   myproduct    In some cases I tend to have common packages that do not belong to a particular product   These would end up categorized according to the functionality of these common classes  e g   io    util    ui   etc  After this it becomes more free-form   Usually I group according to project  area of functionality  deployment  etc   For example I might have  project1    project2    ui    client   etc    A couple of other points    It s quite common in projects I ve worked on for package names to flow from the design documentation   Usually products are separated into areas of functionality or purpose already  Don t stress too much about pushing common functionality into higher packages right away   Wait for there to be a need across projects  products  etc   and then refactor  Watch inter-package dependencies   They re not all bad  but it can signify tight coupling between what might be separate units   There are tools that can help you keep track of this

User · Answer

The way i usually have my hierarchy of folder-   Project Name   src bin tests libs  docs

User · Answer

You could follow maven s standard project layout  You don t have to actually use maven  but it would make the transition easier in the future  if necessary   Plus  other developers will be used to seeing that layout  since many open source projects are layed out this way

[java] Package structure for a Java project?

Examples related to java

Examples related to packages