Functional Analysis
Outline
- Functional Analysis
- Definition
- UML Diagrams
- Software Architecture
- Definition
- Separation of Responsibilities
Project Phases
- Analysis of the needs (specifications)
- Planning
- Design
- Development
- Testing
- Deployment
- Maintenance
In traditional projects (V-Cycle), these phases were highly segmented.
Project actors
🚧
- Fonctionnel - Technique
- Besoin Métier
- MOA - MOE
- Etude préalable, budget, temps, qualité - Cahier des charges - SFD - Spec technique - Dossier test
- SCRUM
- Important de discuter
- Reformulez
- Utilisez des mots simples
- Imaginez que vous expliquez le projet à vos grands parents
- parler doc, arrivée sur poste, initiatives
What is Functional Analysis?
- First step in all projects
- Determines the functions and actors of the product to meet client needs
- Diagrams to communicate with the client
- Prioritizes tasks
- Permet de s’approprier le sujet
- Ce n’est pas du temps perdu car rajouter des fonctionnalités non prévues est extrêmement compliqué
- Cette phase sera la première partie du rapport intermédiaire
coût d’ajout d’une fonctionnalité / coût correction bug
Cost of Change Curve:
- Cahier des charges : 1 €
- Développement : 10 €
- Tests : 50 €
- Production : 100 €
Questions to Ask
- What types of users will use my application (administrator, manager, client, etc.)?
- What are the features? Common features between profiles?
- How do the application processes work?
- Which diagrams should be used?
- Use case diagrams for the first questions
- Activity diagrams for processes
- Why create diagrams? At a glance, you have all the information
- Comment on your diagrams
UML Diagrams
- First-year course
- UML 2.5, Pascal Roques, Eyrolles, Memento (ENSAI library)
It is agnostic of the chosen programmation language !
A functional analysis UML diagram is its own language.
- No time to redo a course
- Resources are available in the library and online
- Ask your tutor what they expect
Software Architecture
Voila pour les grand principes.
On va maintenant rentrer dans le concret.
What is Software Architecture?
- The technical counterpart of functional analysis
- Now that we have the who and what, we determine the how
- We design the code of our application
- Macro vision of our application (arrangement of major components)
For now, we are not yet writing code.
We will only draft our application with the components it comprises (both logical and physical).
For example, in your case, you will likely have:
- Python code running on your computer
- An external web service providing data
- A PostgreSQL database.
These are already 3 components, but quickly there will be many, and we need to know how to arrange them.
Why It’s Important: Parallel with Architecture
- Rooms, electrical installation, water, gas, legislative constraints, adapting to the terrain…
- Need to think about how to arrange all this from the beginning
- If we build as we go, we risk ending up with an inconsistent house (at best)
- This is not wasted time!
Some people even say we should spend more time analyzing than coding. This is debatable, but it shows how important the analysis phase (how to code the functions) is!
genAI can almost code for us.
A Major Principle: Separation of Concerns
Macro version in 3 layers.
- Presentation: everything related to display
- Business: the core of your application, its added value
- Data: data storage
Each layer communicates with adjacent layers.
A layer only needs to know how to request information and what is returned. Not obvious but very important!!!
Main Layers of an Application
- Presentation: everything related to display (web page, console, window)
- Business: the core of your application, its added value
- Persistence: manages data persistence. Database or file system
Dans le monde pro :
- Présentation : JavaScript
- Métier : Java / Python
- Persistance : PostgreSQL ou MariaDB
For Your Project
- Presentation: Front-end
- Business: Back-end
- Persistence: Database
Exemple page web
Zoom sur la couche métier
Within the Business layer, there are several sub-layers.
In the practical work:
- Presentation layer: View (navigate between views)
- DAO, business_object, service
- Controller: It receives user requests via the user interface (e.g., an HTTP request in the case of a web application) and calls the appropriate services to execute the requested actions.
Layers of the Business Layer 1/2
- DAO (Data Access Object):
- The part of your code that communicates with the database (Lecture 4/Practical 4)
- Service:
- Business code
- Manipulates business objects to create information or value
- Requests objects from the DAO layer (Practical 4)
- Calls external web services (Practical 3)
Layers of the Business Layer 2/2
- Business Objects:
- Transversal layer
- Represent business concepts that your code will manipulate
- Objects with mostly attributes and few methods
- Controller:
- Retrieves user inputs
- Returns data to be displayed
We break down the objects:
- Attributes -> Business Objects (~DTO)
- Methods -> Services
Why Separate into Layers?
- Teamwork 🦸♀️🧙♂️👨💼👩🔬
- Code readability 📖
- Debugging 🐞
Limit the risk of errors when modifying code (avoid spaghetti code) 🍝
Il faut savoir qu’un code doit être lisible par les autres.
Et les autres, ça peut être soi-même dans 2 mois. Blague sur la relecture de code.
Si on a un code bien séparé, différentes équipes peuvent travailler en parallèle.
Et séparer en couches permet de trouver rapidement la source du problème.
Key Takeaways
- Spending time thinking about the different modules of an application is not a waste of time 🕵️♀️
- Dividing into layers allows parallel work 🧪🧫📚
- But we still need to think about how to code well 🤖
Possible in the project to distribute the layers.